https://github.com/hegemonic/jsdoc-baseline

An experimental, extensible template for JSDoc.
https://github.com/hegemonic/jsdoc-baseline

api baseline docs documentation javascript jsdoc template

Last synced: 6 months ago
JSON representation

An experimental, extensible template for JSDoc.

• Host: GitHub
• URL: https://github.com/hegemonic/jsdoc-baseline
• Owner: hegemonic
• License: other
• Created: 2013-12-27T23:39:57.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2025-12-11T04:51:08.000Z (6 months ago)
• Last Synced: 2025-12-11T08:23:33.825Z (6 months ago)
• Topics: api, baseline, docs, documentation, javascript, jsdoc, template
• Language: JavaScript
• Homepage:
• Size: 4.88 MB
• Stars: 61
• Watchers: 4
• Forks: 31
• Open Issues: 53
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
# Baseline

![Build status](https://img.shields.io/github/actions/workflow/status/hegemonic/jsdoc-baseline/build.yaml?branch=main&style=flat-square)

[![npm version](https://img.shields.io/npm/v/jsdoc-baseline.svg?style=flat-square)](https://www.npmjs.org/package/jsdoc-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:

    ```sh

    npm install --save-dev jsdoc

    ```

2.  Add the Baseline template to your Node.js project as a development dependency:

    ```sh

    npm install --save-dev jsdoc-baseline

    ```

## Configuring and using Baseline

To use the Baseline template with its default settings, run JSDoc with the `--template` (or `-t`)

command-line option:

```sh

jsdoc --template  

```

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 `baseline-config-example.json` for information

    about the supported options. You can use comments in the configuration file.

3.  Update your JSDoc `conf.json` file to include a `templates.baseline` property. This property

    must contain the path to your Baseline configuration file.

4.  Run JSDoc as shown above, using the `--configure` (or `-c`) option to tell JSDoc where to find

    your `conf.json` file:

```sh

jsdoc --configure  --template  

```

## Legal stuff

Copyright 2014 the Baseline Authors. Licensed under the Apache License, Version 2.0. See

[LICENSE.md][license] for more information.

[jsdoc]: https://github.com/jsdoc/jsdoc

[license]: https://github.com/hegemonic/jsdoc-baseline/blob/master/LICENSE.md

[nunjucks]: https://mozilla.github.io/nunjucks/