diff options
| author |  Miek Gieben <miek@miek.nl>
| 2018-01-04 12:53:07 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2018-01-04 12:53:07 +0000 |
| commit | 58221f55db5675c6107d19679c46a216ed072aca (patch) | |
| tree | f4f86c8ecd35538da492524dec549566daf40809 /plugin.md | |
| parent | 0600f8c058f39c7afec9f915657e06f158d21c47 (diff) | |
| download | coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.gz coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.zst coredns-58221f55db5675c6107d19679c46a216ed072aca.zip | |
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.
Diffstat (limited to 'plugin.md')
| -rw-r--r-- | plugin.md | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -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. |