Go the root and type gulp docs.
If you want to test the static website, follow these steps:
- To test documentation, follow these steps:
- Install ruby & jekyll if you don't have it: http://jekyllrb.com/docs/installation/
gem install pygments.rb --version "=0.5.0"gem install wdmgem install jekyll --version "=1.4.2"
- Go back to project root and build the docs & the website in one task
gulp build-site
- Launch the local webserver.
gulp site
- Open http://localhost:4000/docs/api/ and see your changes! Re-run
gulp build-siteagain whenever you change something.
Templates in templates folder
templates/pages-data.template.html=>_layout/docs_api.htmltemplates/index.template.html=> The 'index' page for a doc versiontemplates/lib/yaml.template.html=> the common yaml config items that every doc page includestemplates/api/componentGroup.template.html=> the template for every 'componentGroup' - eg an angular moduletemplates/api/api.template.html- the base that every doc-item extends fromtemplates/api/{something}.template.html- the template for {something} - eg directive.template.html for directives
Not everything in all the pages is used - a lot of it is from Angular templates. Eg things like 'doc.deprecated' aren't used currently.
New Versions
Every version uses its own include for left menu, which is generated based on the docs available.
The first time a version is generated, if there is no includes/api_menu{{versionName}}.html, it will generate a generic one for you.
Then you can do what you want to edit that.