Browse Source

Merge pull request #20406 from abpframework/EngincanV/docs-module-documentation-update

Update docs module documentation and mention about the new features.
pull/20416/head
Engincan VESKE 2 years ago
committed by GitHub
parent
commit
bb84c7ee1e
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. BIN
      docs/en/images/cmskit-module-markedItems.png
  2. BIN
      docs/en/images/docs-referencing.png
  3. 54
      docs/en/modules/docs.md

BIN
docs/en/images/cmskit-module-markedItems.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

After

Width:  |  Height:  |  Size: 5.7 KiB

BIN
docs/en/images/docs-referencing.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

54
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<DocsUiOptions>(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<DocsUiOptions>(options =>
{
options.MultiLanguageMode = false;
});
```
## See Also

Loading…
Cancel
Save