Angular Docs- The Hidden Gem
I have been searching for a Documentation website that is clean, simple and that can be integrated with GitHub, like most open-source project documentation websites are built. And my primary criteria something that is built in Angular itself. Microsoft Docs has been my favorite, but not anymore :-)
I did not know that Angular Docs website is built on Angular and has all the features that i’m looking for. Also found out that NgRx docs and RxJs docs sites are built/using Angular docs codebase.
The best part is that the codebase for the complete Angular docs website is on GitHub.
We can actually build a documentation website for your projects using Angular Docs codebase.
Installation
# Create new directory
mkdir angular-codebase
cd angular-codebase# Clone Angular repo
git clone https://github.com/angular/angular.git# Downloads the source into a new folder - angular
cd angular# Go to 'aio' directory that holds the docs website
cd aio# build (need to have latest yarn and node)
yarn build# run locally, use '-p' to use a custom port
yarn http-server dist -p 4201
That’s it, you should be able to see the complete Angular docs website on your local machine. I was very excited to see this running on my local.
Of course this was intended for the community to contribute to Angular docs via GitHub, and i don’t think, Angular developer community would object us cloning this repository to build other sites.
If you enjoyed reading this, i’m always looking for curious people to write/talk about tech. Or, if you just want to talk, ping me up on twitter any time @surenkonathala
