update README.md so everything is rendered correctly #370
Conversation
README.md
Outdated
|
|
||
| * `templ_name`: The name of the template. This name will be found in the Web interface. | ||
| * `templ_source`: The location of the XML file wich needs to be imported. | ||
|
|
||
| ##limitations | ||
| ## limitations |
There was a problem hiding this comment.
should we switch to "Limitations"?
|
Thanks for the PR @Cosaquee! We should really use a markdown validator... |
|
@bastelfreak do you have any specific validator in mind ? I found https://github.com/mivok/markdownlint and I can probably spend some time and see how it works and connect it to this repo, in form of rake task. : ) |
|
We manage all our rake tasks with a central modulesync_config repository. We already have an (older) issue about markdown linting. voxpupuli/modulesync_config#182 Contributions are always welcome. Feel free to comment on it or provide an example. You can add a linter to any of our repos and we can later adopt it to modulesync, which then provides it to all of our modules. |
|
For now i think it is good idea to merge this PR so README can be readable again. In mean time i will research problem of Markdown linting and open new PR if i will have some code ready. |
|
please check my inline comment. I think we should switch limitations to Limitations? Since all the other headlines start with a capital letter. |
|
@bastelfreak done :) |
|
can you check the readme again? There are: '###Usage zabbix-agent' and '###Usage zabbix-proxy' which also need an additional whitespace. |
No description provided.