https://github.com/ng-doc/ng-doc

📃 The documentation engine for Angular projects
https://github.com/ng-doc/ng-doc

angular api builder demo documentation generator guidelines guides ng-doc

Last synced: 21 days ago
JSON representation

📃 The documentation engine for Angular projects

• Host: GitHub
• URL: https://github.com/ng-doc/ng-doc
• Owner: ng-doc
• License: mit
• Created: 2022-05-24T19:53:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T18:57:49.000Z (about 2 months ago)
• Last Synced: 2024-05-17T12:21:18.215Z (about 2 months ago)
• Topics: angular, api, builder, demo, documentation, generator, guidelines, guides, ng-doc
• Language: TypeScript
• Homepage: https://ng-doc.com
• Size: 14 MB
• Stars: 171
• Watchers: 4
• Forks: 15
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-stars - ng-doc/ng-doc - 📃 The documentation engine for Angular projects (documentation)
• awesome-angular - ng-doc - The documentation engine for Angular projects. (Table of contents / Angular)

README

        





  

    

  

NgDoc

  


    Create user-friendly documentation for your projects with ease!

    


    Documentation

    ·

    Report Bug

    ·

    Request Feature

[![GitHub Workflow Status][build-shield]][build-url]

[![NPM][npm-shield]][npm-url]

[![MIT License][license-shield]][license-url]

  



## About The Project

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

- Create playgrounds for your Angular Components and Directives

- 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!

## Installation

To know how to install and use NgDoc, please check our [documentation](https://ng-doc.com/).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire,

and create. Any contributions you make are **greatly appreciated**. Please read the

[Contributing Guidelines](CONTRIBUTING.md) for more information.

[npm-shield]: https://img.shields.io/npm/v/@ng-doc/builder.svg?style=for-the-badge

[npm-url]: https://www.npmjs.com/package/@ng-doc/builder

[license-shield]: https://img.shields.io/github/license/ng-doc/ng-doc.svg?style=for-the-badge

[license-url]: https://github.com/ng-doc/ng-doc/blob/main/LICENSE

[build-shield]: https://img.shields.io/github/actions/workflow/status/ng-doc/ng-doc/release.yml?style=for-the-badge&branch=release

[build-url]: https://github.com/ng-doc/ng-doc/actions