GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → compodoc → Compodoc

compodoc / Compodoc

Licence: mit
📔 The missing documentation tool for your Angular, Nest & Stencil application

Programming Languages

typescript
32286 projects
Handlebars
879 projects
javascript
184084 projects - #8 most used programming language
CSS
56736 projects

Labels

angulardocumentationgeneratorangular2astdevtoolsdocumentation-tooljsdoc

Projects that are alternatives of or similar to Compodoc

Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (-66.39%)
Mutual labels:  documentation, documentation-tool, jsdoc, generator
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (-83.07%)
Mutual labels:  documentation, documentation-tool, generator
Documentation
📖 documentation for modern JavaScript
Stars: ✭ 5,443 (+52.59%)
Mutual labels:  documentation, documentation-tool, jsdoc
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-91.98%)
Mutual labels:  documentation, documentation-tool, generator
Csstree
A tool set for CSS including fast detailed parser, walker, generator and lexer based on W3C specs and browser implementations
Stars: ✭ 1,121 (-68.57%)
Mutual labels:  ast, generator
Generator
Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
Stars: ✭ 237 (-93.36%)
Mutual labels:  documentation, generator
Esdoc
ESDoc - Good Documentation for JavaScript
Stars: ✭ 2,706 (-24.14%)
Mutual labels:  ast, jsdoc
jsdast
JSDoc Abstract Syntax Tree
Stars: ✭ 20 (-99.44%)
Mutual labels:  jsdoc, ast
Apigen
PHP 7.1 ready Smart and Simple Documentation for your PHP project
Stars: ✭ 2,068 (-42.02%)
Mutual labels:  documentation, generator
jsdoc-api
A programmatic interface for jsdoc3 with a few extra features
Stars: ✭ 55 (-98.46%)
Mutual labels:  jsdoc, documentation-tool
docgen
The docs.json generator for discord.js and its related projects
Stars: ✭ 59 (-98.35%)
Mutual labels:  generator, jsdoc
Yii2 Apidoc
Yii 2 apidoc extension.
Stars: ✭ 236 (-93.38%)
Mutual labels:  documentation, generator
Hexo Theme Doc
A documentation theme for the Hexo blog framework
Stars: ✭ 222 (-93.78%)
Mutual labels:  documentation, documentation-tool
Query Translator
Query Translator is a search query translator with AST representation
Stars: ✭ 165 (-95.37%)
Mutual labels:  ast, generator
Cgx
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
Stars: ✭ 190 (-94.67%)
Mutual labels:  documentation, generator
ts-lehre
Generate document block(JsDoc, EsDoc, TsDoc) from source code
Stars: ✭ 14 (-99.61%)
Mutual labels:  generator, jsdoc
Literate.jl
Simple package for literate programming in Julia
Stars: ✭ 272 (-92.37%)
Mutual labels:  documentation, documentation-tool
Devdocs Macos
An unofficial DevDocs API Documentation viewer for macOS.
Stars: ✭ 258 (-92.77%)
Mutual labels:  documentation, documentation-tool
Investigate.vim
A Vim plugin for looking up documentation
Stars: ✭ 282 (-92.09%)
Mutual labels:  documentation, documentation-tool
Terraform Docs
Generate documentation from Terraform modules in various output formats
Stars: ✭ 2,483 (-30.39%)
Mutual labels:  documentation, generator
View All Similar Projects ➔

Compodoc: The missing documentation tool for your Angular application
Github action Build Status Codecov npm badge Quality Gate Status
NPM Downloads MIT badge

saucelabs badge

Gitter badge

The missing documentation tool for your Angular application.

Compodoc: The missing documentation tool for your Angular application

Live Demo

A live demo is available — see it in action !

The demo features documentation generated for a simple TodoMVC application.

Features

  • Clean, simple design — Navigate the documentation on the left side, read it on the right.

  • Beautiful themes — Seven themes are available from well known documentation tools like Gitbook, Read the Docs and projects like Vagrant, Laravel, Postmark and Stripe.

  • Search — Includes a powerful search engine (lunr.js) for easily finding what you're looking for.

  • Automatic table of contents — API table of contents is generated using elements found during files parsing.

  • JSDoc light support — Support for @param, @returns, @link, @ignore and @example tags.

  • Documentation coverage — Get the documentation coverage report of your project.

  • Angular CLI-friendly — Supports Angular CLI projects out-of-the-box.

  • Offline — No server needed, no sources uploaded online, documentation generated entirely offline.

  • Open-source and on npm — Use it directly in your project using npm and a single script—that's it!

Documentation

Official documentation has moved to https://compodoc.github.io/website/.

Installation

Ready to get started? Read installation instructions.

🏅 Backers

Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. Become a backer

Backers

🎖 Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

Sponsors

Contributing

Want to file a bug, contribute some code, or improve documentation? Excellent!

Read up on our guidelines for contributing.

Contributors

This project exists thanks to all these people.

vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky guilhermevrs Blakesalot Brigitte Hofmeister lichangfeng
dp-1a ValentinGot Blake Simmon Brigitte Hofmeister lichangfeng

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

License

Everything in this repository is licensed under the MIT License unless otherwise specified.

Copyright (c) 2016 – 2019 Vincent Ogloblinsky

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].