diff options
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..e4b181b42 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Alaveteli documentation (github pages) + +The `gh-branch` contains the Alaveteli documentation that is hosted +as GitHub Pages, and available at code.alaveteli.org + +The styling comes from the +[mysociety-docs-theme](https://github.com/mysociety/mysociety-docs-theme) +repo, which is included as a submodule in the `theme/` directory. + +If you're building locally, and you change the theme, rebuild it with: + +`sass --update theme/sass/:assets/css/` + +To view the documentation locally using Jekyll, do something like: + +`jekyll serve --watch` + + + |