Releases: sam0x17/docify
Releases · sam0x17/docify
v0.1.6
v0.1.5
v0.1.4
v0.1.3
adds compile_markdown!(..)
macro. This is meant to run with #[cfg(doc)]
attached to it, and will take in the path to a markdown file or a directory of markdown files, and a target directory (optional). All markdown files will be processed at compile-time such that comments of the form <!-- docify::embed!(..) -->
will be processed like regular docify::embed!(..)
calls, allowing you to embed examples from throughout your project directly in markdown files. This is particularly useful for keeping examples in README.md
up-to-date.
v0.1.1
v0.1.2
- major re-work of how source code is extracted
- now uses a string compression technique to step through the original source string and extract the original item source code, unmodified after it has been identified by syn
- this means that all types of comments now work in exported examples, previously only doc comments worked 🎉
- if this process fails for whatever reason, a compile-error will be issued, but hopefully there are no pathological examples I haven't considered. If you run into an issue please follow the prompt in the compile error and submit an issue accordingly 🙏🏻