NgDoc

Create documentation faster than ever!
Explore the docs »

Roadmap · Report Bug · Request Feature

This project was originally created to speed up the writing of documentation for your Angular libraries and applications and make it flexible. We want to make this process as quick and easy as possible for you so that you can focus on writing code and not on finding solutions for your documentation.

NgDoc allows you to do the following things:

• Dynamic markdown templates for your guidelines via Nunjucks
• Render demos on the page in one line of code
• The documentation for your API is based on comments to your code
• Dynamic links to API, Pages, or foreign websites via Keywords feature
• Automatic generation of links to your API in code examples or in mentions of any entity inside inline code
• Offline search that collects indexes automatically based on you documentation
• Customizable interface
• And much more, just check out our roadmap to find out what will be in future releases.

Warning This library was created for Angular 15+ projects, it may not work with previous versions

First of all you need an Angular application which will be used to render the documentation, after that you can install NgDoc using the command below, it will automatically install all the necessary packages and configure your application.

ng add @ng-doc/add

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(features-scope): add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request