pub-theme-doc
v1.2.0
Published
pub-server documentation theme
Downloads
72
Readme
pub-theme-doc
pub-server default theme with responsive sidebar.
installation
This theme is included with pub-server.
To use this theme in a project, include "pub-theme-doc" in the "pkgs" array in pub-config.js.
This theme will reference pub-pkg-font-awesome
icons, if included in pkgs
. For syntax highlighting, combine this theme with either pub-pkg-prism or pub-pkg-highlight.
to customize the header text and github url
In pub-config set the following:
opts.docTitle
and optionallyopts.docSubTitle
opts.github
to customize the header content structure
In your downstream project create fragments with the following names, to replace the defaults.
---- /#navicon ----
_!bars fw lg_
---- /#doctitle ----
# [Awesome Framework](/)
documentation
---- /#topmenu ----
- [](/about-us)
- [_!github lg fw_](https://github.com/jldec/pub-server)
responsive view
On small screens, the navigation sidebar will be hidden, and appear when hovering over the navicon.
credits
- github-like markdown css thanks to https://github.com/sindresorhus/github-markdown-css