A theme for the Cabin static site generator.
This theme is used to build project documentation sites. It is great for use on GitHub or for internal projects within a company.
Click here to see a demo of what it looks like.
Before using DocLog, make sure you have Cabin installed:
npm install -g cabinThen run the following command to scaffold out a site generator using this theme:
cabin new docs ChrisWren/DocLogAfter scaffolding a site generator, you can run it by entering the following command in the docs folder:
gruntThis theme uses IcoMoon's icon fonts when creating icon menu links. To use different icons in your project, select icons in the IcoMoon app, then click fonts and download the fonts and css into the src/styles folder.
Here are the following post properties used by this theme:
Type: String
The title of the post which is used in the url, document title, and the header of the generated documentation page.
Type: String
This property optionally overrides the title so that the document title and header are different from the url. This is useful in overriding the root post which has the title index as you will likely want to display something else.
Type: String
This is the class suffix of the icon to use in the navigation. For example, if I specified icon: home, the navigation would use the IcoMoon class icon-home when rendering the icon-font navigation link to the post.