Crate md_gen[−][src]
md_gen is a framework for generating documentation in markdown. It can generate metadata compatible with Vuepress.
Purpose
md-gen is intended to generate Vuepress compatible (or basic) markdown site. It is usefull for documenting from complex data structures.
By now, every call beginning with add_*
is generated on its own line in the markdown source. You can mix different formats on the same line using add_text(text: &str)
.
Some exceptions are multi-lines :
- table headers
- definition
- unordered / ordered lists
- specific code
- …
Re-exports
pub use crate::md_gen::Markdown; |
pub use crate::md_gen::Metadata; |
Modules
md_gen |