tree: add3b4cebdc09f5ab10deaf2c5c4013e56f30db4 [path history] [tgz]
  1. _includes/
  2. _layouts/
  3. css/
  4. images/
  5. .gitignore
  6. _config.yml
  7. BUILD.bazel
  8. Built-ins.md
  9. examples.md
  10. index.md
  11. install.md
  12. Jasmine.md
  13. Karma.md
  14. Protractor.md
  15. README.md
  16. repositories.md
  17. Rollup.md
  18. Terser.md
  19. TypeScript.md
docs/README.md

Developing on the docsite

Running locally can be done with Jekyll. Follow setup instructions at https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll

Run

docs$ bundle exec jekyll serve

Another way to do local development without doing the Ruby setup steps is to use a docker container:

$ docker run -it --rm -v "$PWD":/usr/src/app -p "4000:4000" starefossen/github-pages

Authoring the docsite

The docsite is a mix of stardoc generated markdown and hand written markdown.
The files marked with

<!-- *********************
 DO NOT EDIT THIS FILE
  It is a generated build output from Stardoc.
  Instead you must edit the .bzl file where the rules are declared,
  or possibly a markdown file next to the .bzl file
 ********************* -->

Should be edited by modifying the docs in the source .bzl files, other files can be freely edited.