How to use
The first step is to simply clone the Herodotus repo:
git clone --depth=1 https://github.com/kazzkiq/herodotus.git
Then, inside your cloned repository, install Brunch and Herodotus dependencies:
Brunch is a tiny powerful build tool needed to run Herodotus.
npm i -g brunch && npm i
Now, in order to start the documentation, you can simply run this command, and access localhost:3333 in your browser:
And that’s it.
Now that you have your documentation up and running you can start writing into markdown files to see changes in realtime!
To generate production files, run: npm run build. Your production code can be found in /public folder.
- 100% Static (deploy it on Github Pages, Surge, Now, etc);
- Mobile friendly (off-canvas menu navigation, nice and responsive interface);
- Easily themeable (simply modify
variables.scssto change colors, sizes, etc);
- Navigation generated automatically from
- With all those features built-in, Herodotus still weights only ~80kb gzipped (~1 second load time on a 2G connection).
Babel is used as transpiler, so you’re free to write ES6 code and your application should still run on ES5 browsers.
The CSS is written using Sass.
By making use only of static files, Herodotus works in basically any environment, as long as it supports AJAX requests (Herodotus do only one AJAX request at the application startup in order to load the documentation markdown file).
For further details, please check the documentation.