{"repo":"hegemonic/jsdoc-baseline","free":true,"listed":false,"github":"https://github.com/hegemonic/jsdoc-baseline","clone":"git clone https://github.com/hegemonic/jsdoc-baseline.git","description":"An experimental, extensible template for JSDoc.","language":"JavaScript","stars":61,"topics":["baseline","jsdoc","javascript","api","docs","documentation","template"],"license":null,"category":"docs-static-sites","readme_excerpt":"Baseline An extensible template for [JSDoc][jsdoc]. This is a preview version of the Baseline template. Baseline is under active development. Everything in the template is subject to change. What is Baseline? Baseline is an HTML template for [JSDoc][jsdoc]. It offers several benefits: - Extensible from the ground up. You can use extensions to customize your documentation's content and appearance without changing Baseline itself. In addition, you can localize the headings and other text that are added by the template. Note: Customization options are limited in this preview version. - Easy to navigate. An expandable table of contents helps users find what they're looking for. Also, a summary at the top of each page shows what's documented on that page. - Modern template syntax. Baseline uses [Nunjucks][nunjucks], a powerful JavaScript template engine, to define the template layout. You can define new Nunjucks filters and use them in your customizations to Baseline. Installing Baseline 1. Add [JSDoc][jsdoc] to your Node.js project as a development dependency: 2. Add the Baseline template to your Node.js project as a development dependency: Configuring and using Baseline To use the Baseline template with its default settings, run JSDoc with the --template (or -t ) command-line option: To use the Baseline template with customized settings: 1. Copy baseline-config-example.json to a new file (for example, baseline-config.json ). 2. Modify the configuration file as needed. See baseli","default_branch":null,"files":null,"tree":[],"storefront":"/r/hegemonic","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hegemonic/jsdoc-baseline/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}