Tome provides a simple way to view plain-text documentation, including notes or journal entries.
Tome documents are authored in Markdown format. Save any number of files named with the ".md" suffix. Tome will scan directories for all markdown files and render them into a single web page.
The web page produced by Tome is read-only. To author documents, use any text editor. To organize documents, use file names and directory structure. To collaborate with others, consider a version control system. Tome does not try to replace these tools. Tome only takes in an easy-to-write format (markdown with a few extensions), and renders to an easy-to-read format (web page with simple navigation).
Many thanks to goldmark for Markdown parsing, and to Slate for HTML and CSS.
Tome Command
The tome
command scans directories for Markdown files with names ending ".md".
Tome renders those files as a web page (HTML), served over HTTP.