Sha256: b210426c6225dcc2865aaf2cdfd2896e7b1e479b04a8d4a9c596edc8af1741e3
Contents?: true
Size: 1.45 KB
Versions: 2
Compression:
Stored size: 1.45 KB
Contents
# DocGen DocGen is a document generation helper built using Jekyll, as an alternative to LaTeX for the uninitiated. It is NOT for blogging. Uses MathJax for custom styles. ### Includes API - `{% include page-break-docgen %}` - Inserts a page break when printing, useful when printing to PDF - `{% include break %}` - Shortcut for `{% include page-break-docgen %}` ### CSS API Some of the available styles are easier to use without an `include`. - `div.page-break` - A page break. - `div.display` - A `div` that follows flexbox wrapping rules. - `ol.heirarchical` - A list that supports the numbered-lettered-numeraled structure. ### Layouts #### Documents - `default-docgen` - Base layout for docgen. - `latex-docgen` - Emulates a LaTeX document. - `mla-docgen` - Emulates an MLA-style document, i.e. 12pt Times New Roman with header. #### Utility Pages - `index-docgen` - Utility page that lists all documents. - `404-docgen` - Utility page for handling 404 errors. - `default` - shortcut for `default-docgen`. - `latex` - shortcut for `latex-docgen`. - `mla` - shortcut for `mla-docgen`. ### Page & Site Properties - `lang` - Set the language in `_config.yml` or in the front matter - `mla` & `mla-docgen` - In the front matter, you can set: - `author` - `instructor` - `course` - `date` All of which are copied verbatim. You can also set `title` in the front matter, which is copied verbatim into own paragraph where the MLA standard says it should go.
Version data entries
2 entries across 2 versions & 1 rubygems
Version | Path |
---|---|
jekyll-theme-docgen-1.2.1 | README.md |
jekyll-theme-docgen-1.2.0 | README.md |