This is the default template for [Docma][docma-repo]; with a side-bar symbols menu, search and navigation features; and a beautiful layout.

click to view live

Usage

1. Make sure you have the latest [Docma][docma-repo] installed.
2. Although Zebra is installed together with Docma, you can still install/update this template via npm: npm i docma-template-zebra -D
3. Set template.path to "default" or "zebra" or omit it in your build configuration (docma.json).
4. Configure and set template.options as described below.

Template Options

Template specific options that can be used when building your documentation with Zebra.

$3

Linked labels that build the navigation menu on the top bar of the document. Each item is an arbitrary Object with the following properties.

Usage with Docma

Template options are defined within the [build configuration][build-conf]. i.e. in a docma.json file.

``js
{
"template": {
// Docma Template to be used.
// Either a path, module name or "default"
"path": "zebra",
// Zebra template-specific options
"options": {
"title": {
"label": "My Library",
"href": "/base/"
},
"logo": {
"dark": "img/dark-logo.png",
"light": "img/light-logo.png"
},
"sidebar": {
"enabled": true,
"outline": "tree",
"collapsed": false,
"toolbar": true,
"itemsFolded": false,
"itemsOverflow": "crop",
"badges": true,
"search": true,
"animations": true
},
"symbols": {
"autoLink": true,
"params": "list",
"enums": "list",
"props": "list",
"meta": false
},
"contentView": {
"bookmarks": "h1,h2,h3",
"faLibs": "solid,regular,brands"
},
"navbar": {
"enabled": true,
"dark": false,
"animations": true,
"menu": [
{
"label": "Docs",
"iconClass": "fas fa-book",
"href": "./"
},
{
"label": "Demos",
"iconClass": "fas fa-mouse-pointer",
"href": "?content=demos"
},
{
"label": "Download",
"iconClass": "fas fa-cloud-download-alt",
"items": [
{
"label": "v0.5.0-pre",
"href": "https://github.com/user/repo/archive/v0.7.0-pre.zip"
},
{ "separator": true },
{
"label": "v1.0.0",
"href": "https://github.com/user/repo/archive/v1.0.0.zip"
}
]
},
{
"label": "GitHub",
"iconClass": "fab fa-github",
"href": "https://github.com/user/repo",
"target": "_blank"
}
]
}
}
},
// other build configuration options
// src, dest, app, jsdoc, markdown, debug, etc...
}
`
Then you can build your documentation with these customized template options.

`js
Docma.create()
.build('path/to/docma.json')
.then(() => {
console.log('Documentation is built successfully.');
})
.catch(err => {
console.log(err);
});
`

...or build via CLI:

`sh
docma -c path/to/docma.json
``

Changelog

See [CHANGELOG][changelog].
_Note: If you're upgrading from Zebra v1.x to v2.x, there are some [breaking changes][changelog]._

License

[MIT][license].

Emoji shortcuts used in source markdown files are parsed into [twemoji][twemoji]. Graphics and icons licensed under [CC-BY 4.0][cc-by-4]. See FontAwesome [license][fa-license].

[docma-repo]:https://github.com/onury/docma
[build-conf]:https://onury.io/docma/api/#Docma~BuildConfiguration
[license]:https://github.com/onury/docma/blob/master/templates/zebra/LICENSE
[changelog]:https://github.com/onury/docma/blob/master/templates/zebra/CHANGELOG.md
[twemoji]:https://github.com/twitter/twemoji
[cc-by-4]:https://creativecommons.org/licenses/by/4.0
[fa-license]:https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt