<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/ng-doc/ng-doc">
    <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px">
  </a>

<h1 align="center" style="margin-bottom: 0; border-bottom: 0">NgDoc</h1>
  <p align="center">
    Create user-friendly documentation for your projects with ease!
    <br />
    <a href="https://ng-doc.com/">Documentation</a>
    ·
    <a href="https://github.com/ng-doc/ng-doc/issues/new/choose">Report Bug</a>
    ·
    <a href="https://github.com/ng-doc/ng-doc/issues/new/choose">Request Feature</a>

[![GitHub Workflow Status][build-shield]][build-url]
[![NPM][npm-shield]][npm-url]
[![MIT License][license-shield]][license-url]

  </p>
</div>

<!-- ABOUT THE PROJECT -->

## About The Project

This library is a part of NgDoc project, that uses to create documentation
for Angular projects, please check our [repo](https://github.com/ng-doc/ng-doc) for more details.

[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/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[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
