Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Tips and Traps
- The very first run of MyST markdown in a JupyterLab cell might fail to work. Just rerun it and it should work.
Writing Docs Using Markdown
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Markdown Standard
- CommonMark is the Markdown standard. Its specs can be found at commonmark-spec. https://talk.commonmark.org/ is the community forum for CommonMark. Note that CommonMark is supported by GitHub …
RMarkdown Equivalent in Python
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Jupyter/Lab vs RMarkdown
RMarkdown Equivalent in Python
Both CodeBraid and jupyter-book (preferred) are good alternatives to RMarkdown.
CodeBraid
jupyter-book
Pweave
References
Writing an Interactive Book over the Threat Hunter Playbook …
Markdown Tools Written in Rust
Tips on mdBook
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Plugins
mdbook-mermaid
mdbook-mermaid is a preprocessor for mdbook to add mermaid.js support.
References
Make Charts in Markdown Using Mermaid
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
https://frehberg.com/2022/12/docs-as-code-mermaid-inline-diagrams/ Docs as Code: Mermaid inline diagrams
Tools for Rust
https://crates.io/crates/aquamarine Aquamarine is a procedural macro extension for rustdoc, that aims to …