Ensure your markdown files adhere to a specific structure with Markdown Validator. Create a schema (XSD), create your markdown file, and use this tool to validate its structure.
Markdown is a great way to write all sorts of technical documentation. When you have lots of teams producing technical documentation like policies, standards etc you need a way to ensure they're all sticking to the recommended structure. For example we might want to mandate a principal document must contain certain headers, paragraphs in a certain order.
Markdown Validator works by converting the markdown file to xhtml which can be validated against a schema (XSD file). XSD (XML Schema Definition) is a World Wide Web Consortium (W3C) recommendation that specifies how to formally describe the elements in an Extensible Markup Language (XML) document.
Ultimately all you have to do is provide a schema (XSD file) and a markdown file and the tool will let you know if the markdown file conforms or not.
- Download the files
- Navigate to the directory that contains the files from this project
- Run
pip3 install -r requirements.txtto make sure you have all the requirements installed - Run the validator:
python3 mdvalidator.py "schema/principal.xsd" "markdown/principal.md". The first parameter is the path to the schema, the second is the markdown to be validated. Test files have been provided so this command will work out the box.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Added some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
29/01/2021: v1 Initial release
- Created by Zain Khan.
- Template for this README is Template-README created by Zain Khan
See the LICENSE file in this project's directory.