Nge-doc NPM | npm.io

Getting started

Ngedoc is a documentation tool for Angular applications. Using Ngedoc, you can create a branded dynamic site from a set from Markdown files or a dynamic Angular coomponents to host the documentation of your projects.

Demonstration

Live demonstration available at https://mciissee.github.io/nge-doc/

Open a terminal and clone this repository

git clone https://github.com/mciissee/nge-doc

Go to nge-doc folder

cd nge-doc

Install the dependencies from package.json

npm install

Start the development server and open http://localhost:4200/

npm start

Docs

Documentation available at https://mciissee.github.io/nge-doc/

Contribution

Contributions are always welcome.

Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.

Please just make sure that ...

Your code style matches with the rest of the project

Unit tests pass

Linter passes

Support Development

The use of this library is totally free and no donation is required.

As the owner and primary maintainer of this project, I am putting a lot of time and effort beside my job, my family and my private time to bring the best support I can by answering questions, addressing issues and improving the library to provide more and more features over time.

If this project has been useful, that it helped you or your business to save precious time, don't hesitate to give it a star and to consider a donation to support its maintenance and future development.