Browse Source

Merge pull request #21593 from abpframework/docpatch

Fix contents of the code are invisible and corrupt in docs module document
pull/21599/head
Engincan VESKE 2 years ago
committed by GitHub
parent
commit
22f671e853
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 36
      docs/en/modules/docs.md

36
docs/en/modules/docs.md

@ -490,9 +490,6 @@ Since not every single document in your projects may not have sections or may no
For example [Getting-Started.md](https://github.com/abpio/abp-commercial-docs/blob/master/en/getting-started.md):
```
.....
​```json
//[doc-params]
{
@ -502,9 +499,6 @@ For example [Getting-Started.md](https://github.com/abpio/abp-commercial-docs/bl
}
​```
........
```
This section will be automatically deleted during render. And f course, those key values must match with the ones in **Parameter document**.
![Interface](../images/docs-section-ui.png)
@ -513,7 +507,7 @@ Now you can use **Scriban** syntax to create sections in your document.
For example:
````
````text
{{ if UI == "NG" }}
* `-u` argument specifies the UI framework, `angular` in this case.
@ -672,22 +666,18 @@ The **Docs Module** supports referencing previous and next documents. It's usefu
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"
}
}
````
```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:

Loading…
Cancel
Save