Supercharge your project's documentation
Looking for the documentation? http://falcao.it/markment
Markment reads a
README.markdown finds any references
.markdown files and generates documentation for
Markment is mostly compatible with github-flavored markdown
Crash course in 3 simple steps
1. Install markment
pip install markment
2. Go to a project that has one or more markdown files
3. Run markment!
Finds markdown files recursively in the given directory tree and generates documentation for them.
Support to metadata related to your project. (You can set project title, description, github url, download url and the themes might make use of it)
You can write your own theme and use it right away through the simple theme development api.
Seriously, creating new themes is a breeze.
Builtin flask server so you can develop your themes preview the documentation before generating all of it.
These are some goals I want to achieve with markment for the next releases.
Full-text search API + template.
API documentation generation for python files (Similar to doxygen). I personally love markdown so much that I actually like to use as my documentation language inside of python docstrings.
We have internally a lot of documentation, but it just wasn't exposed appropriately. Markment can now
You can see it livehere