hegemonic / Jsdoc Baseline
Licence: other
An experimental, extensible template for JSDoc.
Stars: ✭ 51
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Jsdoc Baseline
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (+462.75%)
Mutual labels: api, documentation, docs, jsdoc
Jsdoc
An API documentation generator for JavaScript.
Stars: ✭ 12,555 (+24517.65%)
Mutual labels: api, documentation, docs, jsdoc
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (+766.67%)
Mutual labels: api, documentation, docs
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (+3.92%)
Mutual labels: documentation, docs, jsdoc
Github Template Guidelines
Guidelines for building GitHub templates.
Stars: ✭ 137 (+168.63%)
Mutual labels: documentation, docs, template
Pico8 Api
Unofficial PICO-8 API with a lovely design ! ::
Stars: ✭ 115 (+125.49%)
Mutual labels: api, documentation, docs
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+17868.63%)
Mutual labels: api, documentation, docs
Cljdoc
📚 A central documentation hub for the Clojure community
Stars: ✭ 416 (+715.69%)
Mutual labels: api, documentation, docs
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (+1572.55%)
Mutual labels: api, documentation, docs
Api
姬长信API For Docker 一个基于多种编程语言开源免费不限制提供生活常用,出行服务,开发工具,金融服务,通讯服务和公益大数据的平台.
Stars: ✭ 743 (+1356.86%)
Mutual labels: api, docs
Kin Openapi
OpenAPI 3.0 implementation for Go (parsing, converting, validation, and more)
Stars: ✭ 776 (+1421.57%)
Mutual labels: api, documentation
Api schema
DSL for describing APIs and generate swagger json
Stars: ✭ 18 (-64.71%)
Mutual labels: api, documentation
Wobike
Documentation of Bike Sharing APIs 🚴🛴🛵
Stars: ✭ 705 (+1282.35%)
Mutual labels: api, documentation
Apispec
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..
Stars: ✭ 831 (+1529.41%)
Mutual labels: api, documentation
Docs
Documentation of Vercel and other services
Stars: ✭ 663 (+1200%)
Mutual labels: documentation, docs
Platform Documentation
Core Platform API Documentation & Tutorials
Stars: ✭ 25 (-50.98%)
Mutual labels: api, documentation
Parse Code Context
Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype properties, prototype methods etc.
Stars: ✭ 7 (-86.27%)
Mutual labels: documentation, docs
Documentation
Documentation for the STUPS ecosystem
Stars: ✭ 18 (-64.71%)
Mutual labels: documentation, docs
Baseline
An extensible template for 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. 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, 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
-
Add JSDoc to your Node.js project as a development dependency:
npm install --save-dev jsdoc
-
Add the Baseline template to your Node.js project as a development dependency:
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:
jsdoc --template <path/to/baseline> <path/to/js-files>
To use the Baseline template with customized settings:
- Copy
baseline-config.json.EXAMPLEto a new file (for example,baseline-config.json). - Modify the configuration file as needed. See
baseline-config.json.EXAMPLEfor information about the supported options. You can use comments in the configuration file. - Update your JSDoc
conf.jsonfile to include atemplates.baselineproperty. This property must contain the path to your Baseline configuration file. - Run JSDoc as shown above, using the
--configure(or-c) option to tell JSDoc where to find yourconf.jsonfile:
jsdoc --configure <path/to/conf.json> --template <path/to/baseline> <path/to/js-files>
Legal stuff
Copyright 2014-2021 The Baseline Authors. Licensed under the Apache License, Version 2.0. See LICENSE.md for more information.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].