OpenATFrontEnd
a front-end to OpenAssistive.
To run locally (for the first time)
- Install Hugo: https://gohugo.io
- git clone https://github.com/openassistive/OpenATFrontEnd.git
- cd OpenATFrontend && git submodule update --init --recursive
- hugo server --buildDrafts
To run locally (following the inital run)
- cd OpenATFrontEnd
- hugo server --buildDrafts
To create a new item
- hugo new item/name-of-item.md
- edit content/item/name-of-item.md
or
- cd content/item
- touch name-of-item.md
- edit name-of-item.md
To export the site to gh-pages (linux/mac)
- hugo -d dist --buildDrafts
- ./scripts/deploy_locally.sh
To export the site to gh-pages (windows or other)
Not so straightforward.. Basically you have to build the site (to public) and then copy any changes to a checked out version of the gh-pages branch
Its what that deploy2.sh does for you automagically.
The neatest way in the future is really to make changes directly on github and travis-ci will do the automagic for you
Have a read of:
- https://gohugo.io/overview/quickstart#step-12-deploy-bookshelf-on-github-pages
- https://gohugo.io/tutorials/github-pages-blog#configure-git-workflow
Notes
- Note that the theme is Based at https://github.com/openassistive/openat-hugrid
- The hugo site is a static site generator. Its designed to be run locally and then all /public (or dist - depending on how you want to run the build) is the live static site all in html
- there is a Makefile and a .travis.yml file in this repo. This allows the site to be automagically built on a commit on travis.