writeup-tool

Writeup is a text markup format and standalone tool that translates to HTML5.


Keywords
documentation
License
CC0-1.0
Install
pip install writeup-tool==0.0.1

Documentation

Writeup

Writeup is a text markup format that translates to HTML5. It is similar to Markdown in spirit, but not equivalent. Some differences:

  • Hierarchical sections.
  • Unambiguous character escape syntaxes.
  • Built in Javascript presentation mode.
  • A versioning scheme that should allow for format evolution while preserving the ability to build old source files.
  • Special handling of leading version and license lines.
  • Integration with Muck, a build tool for data projects.

The project is hosted at https:github.com/gwk/writeup, with documentation at https:gwk.github.io/writeup.

License

All of the source code and documentation is dedicated to the public domain under CC0: https://creativecommons.org/.publicdomain/zero/1.0/.