GithubHelp home page GithubHelp logo

doc22940 / compodoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from compodoc/compodoc

1.0 1.0 0.0 42.53 MB

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application

Home Page: https://compodoc.app

License: MIT License

JavaScript 7.19% TypeScript 74.84% HTML 14.99% CSS 2.96% Shell 0.02%

compodoc's Introduction

Compodoc: The missing documentation tool for your Angular application
Linux Build Status Windows Build Status Codecov npm badge Quality Gate Status
npm dependencies npm devDependencies
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

compodoc's People

Contributors

ainsleychang avatar astanley218 avatar bhofmei avatar blakesalot avatar danielleroux avatar danranaldi avatar dp-1a avatar emzet avatar guilhermevrs avatar hueppee avatar jabiinfante avatar jonasmh avatar justinbeckwith avatar kum-deepak avatar liquidautumn avatar mattezell avatar mattlewis92 avatar michael-letcher avatar monkeywithacupcake avatar predorock avatar rprotsyk avatar seokju-na avatar seveves avatar shaungrady avatar sibiraj-s avatar tkt989 avatar tzinckgraf avatar valentingot avatar vogloblinsky avatar vojtechruz avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.