Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 964 Bytes

README.md

File metadata and controls

25 lines (18 loc) · 964 Bytes

hon

Hon is still a work-in-progress.

I'm working toward bringing it up to parity with Gitbook's features, as well as providing certain plugins that are canonical to the Gitbook experience, i.e. search. Currently, it is in a mostly usable state. As it nears completion I will add documentation that details Hon, how to use it, and how it differs from Gitbook and other Gitbook-like tools.

Hon, from the Japanese word for book hon (本) is an alternative command-line tool for building books from Markdown files.

It is intended to be a mostly drop-in replacement for the open source and discontinued version of the Gitbook CLI.

NB: I say drop in, but you'll need to make some configuration changes, and setup a requirements.txt file or some other way of installing the requisite dependencies.