RMcNeely / jsdoc-react-templates

React templating for JSDoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

jsdoc-react-templates

JavaScript Style Guide

Overview

Documenting your code is one of the most important things a developer can do, and JSDoc has become the defacto standard of JavaScript. Unfortunately the tools to create beautiful looking documentation haven't kept up with the rest of tooling in the JavaScript ecosystem. Currently creating a custom JSDoc template involves a lot work in with an outdated templating scheme. This project is an attempt to create an easily accessible standardized template that can be used in place of the standard JSDoc templates.

The main goal of this project is to create a new, maintainable React project that can be used with JSDoc to create beautiful documentation. The goal is heavily inspired by nullobject's deprecated React template for JSDocs.

About

React templating for JSDoc

License:GNU General Public License v3.0


Languages

Language:JavaScript 93.1%Language:HTML 6.9%