Literate programming tool for any language
a year ago
- #programming
- #tools
- #documentation
- Literate programming is a programming style by Donald Knuth, focusing on readability for humans over execution by computers.
- Programs consist of natural language explanations interspersed with executable code snippets, making them easy to understand and share.
- Literate is a tool for creating literate programs, inspired by CWEB but with additional features and simplifications.
- Features include support for any programming language, Markdown-based source, syntax error reporting, and customizable HTML/CSS output.
- Example provided: a simple 'Hello World' in C, demonstrating codeblock definitions and compilation process.
- Installation options include Mac OS X via Homebrew, Linux binaries, and building from source with DMD and Dub.
- Editor support includes micro editor by default and a Vim plugin for syntax highlighting and linting.
- Usage involves compiling .lit files to generate both code and HTML documentation, with various command-line options.
- The project encourages contributions and bug reports, with source code available in literate D.