diff --git a/docs/en/images/cmskit-module-markedItems.png b/docs/en/images/cmskit-module-markedItems.png index 3790049314..52eb61f285 100644 Binary files a/docs/en/images/cmskit-module-markedItems.png and b/docs/en/images/cmskit-module-markedItems.png differ diff --git a/docs/en/images/docs-referencing.png b/docs/en/images/docs-referencing.png new file mode 100644 index 0000000000..2bc3f5da3c Binary files /dev/null and b/docs/en/images/docs-referencing.png differ diff --git a/docs/en/modules/docs.md b/docs/en/modules/docs.md index 6aaf1f2f0a..6ab4f566c0 100644 --- a/docs/en/modules/docs.md +++ b/docs/en/modules/docs.md @@ -666,9 +666,61 @@ See the following examples: ``` ``` ---- +## Referencing Next & Previous Documents +The **Docs Module** supports referencing previous and next documents. It's useful if you have a series of documents that are strictly related to each other and need to be followed one after the other. +To reference the previous and next documents from a document, you should specify the documentation titles and their paths as follows: + +``` + + ````json + //[doc-nav] + { + "Previous": { + "Name": "Overall", + "Path": "testing/overall" + }, + "Next": { + "Name": "Integration tests", + "Path": "testing/integration-tests" + } + } + ```` + +``` + +After you specify the next & previous documents, they will appear at the end of the current documentation like in the following figure: + +![](../images/docs-referencing.png) + +## Single Project Mode + +The **single project mode** allows you to use a single name as a project name in your application. If you are not considering supporting multiple projects with their multiple docs and instead if you have a single project and want to have documentation only for it, it's especially useful for you. + +You just need to configure the `DocsUiOptions`, set the single project mode as **enabled** and also define a constant project name: + +```csharp +Configure(options => +{ + options.RoutePrefix = "docs"; + options.SingleProjectMode.Enable = true; + options.SingleProjectMode.ProjectName = "abp"; +}); +``` + +## Multi Language Mode + +The **multi language mode** allows you to show a combobox that lists and shows all documentation languages and configures the related languages in routes. + +It's enabled by default and supports multiple languages, but if you are considering only supporting a single language, and don't want to show the language combobox in the sidebar of your docs system, you can configure the `DocsUiOptions` and set the multi language mode support as **false** to disable it: + +```csharp +Configure(options => +{ + options.MultiLanguageMode = false; +}); +``` ## See Also