Install the build dependencies and tools via: https://help.github.com/articles/using-jekyll-with-pages/.
git clone git@github.com:Jasig/cas.git cas.sitegit checkout gh-pages- Change documentation as necessary
git push --set-upstream origin gh-pages
./build[sh|bat]To view the site locally:
bundle exec jekyll serveNavigate to http://localhost:4000 to see the local site.
The documentation site is composed of the following blocks:
- Each version of the documentation is moved to an appropriately named folder (i.e.
4.0.0) - Each version contains its own version of the sidebar TOC. While the TOC is designed to be included in the default
Jekyll layout, the site will load the appropriate version of the TOC on
jasig.github.io/cas. - The
currentfolder contains the version of the documentation in development - Developer-related documentation is hosted at the root under the
developerdirectory - The root
index.htmlalways points to thecurrent\index.htmlpage. - Page titles are auto-calculated based on the first
h1element on the page, followed by the version of the documentation (i.e.Service Management (x.y.z))