mirror of
https://github.com/coredns/coredns.git
synced 2025-12-04 17:35:13 -05:00
Manual pages (#1346)
* Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
This commit is contained in:
@@ -20,7 +20,10 @@ Each plugin should have a README.md explaining what the plugin does and how it i
|
||||
file should have the following layout:
|
||||
|
||||
* Title: use the plugin's name
|
||||
* Subsection titled: "Syntax"
|
||||
* Subsection titled: "Named"
|
||||
with *PLUGIN* - one line description.
|
||||
* Subsection titled: "Description" has a longer description.
|
||||
* Subsection titled: "Syntax", syntax and supported directives.
|
||||
* Subsection titled: "Examples"
|
||||
|
||||
More sections are of course possible.
|
||||
|
||||
Reference in New Issue
Block a user