Switch branches/tags
Find file History
Pull request Compare This branch is 131 commits ahead, 7 commits behind GENIVI:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
_includes
_layouts
_pages
_posts
bin
css
fonts
images
js
swagger
Gemfile
Makefile
README.md
_config.yml
index.ad
publish-docs.sh

README.md

These are the source files for the static documentation site hosted on GitHub Pages. The site builds with Jekyll, using asciidoctor and the asciidoctor Jekyll plugin. The theme is jekyll-docs-template.

To get set up to build the site:

bundle install

To see a local version of the site, run jekyll serve, then open a browser at http://localhost:4000/rvi_sota_server/.

To simply build the site without running the local server, run jekyll build; it will output to ./_site/.

To update the site on Github Pages, build the site with jekyll build, then copy the complete generated static site to the gh-pages branch, commit, and push.

You can also build the site using Docker. make will build the site using a docker container and output it to ./_site/.

You can also run a mini server to view your changes from docker, with docker run -it -p 4000:4000 -v $(pwd):/site advancedtelematic/jekyll-asciidoc jekyll serve; the site will be available at http://localhost:4000/rvi_sota_server/.