arena-docs

arena-docs

ARENA Documentation and Tutorials Jekyll site repository

Demo Download

ARENA Documentation Website

This is the ARENA Documentation website giving architecture, APIs, and step-by-step instructions to use the ARENA project. This is a static site generated by Jekyll, and is deployed on push to https://docs.arenaxr.org.

Local Development

  • Install Jekyll
  • Install any new ruby packages: make install
  • Dependencies: make update
  • Build and test: make serve
  • Clean build: make clean
  • Check html: make check
  • Preview site at http://localhost:4000/.

Content

ARENA Documentation pages are written in markdown and placed in the content directory, except for ./index.md.

Each .md file inside content must have YAML Front Matter for navigation. The navigation details are determined by our theme. See the just-the-docs theme for more details about site navigation.

Test

make serve

This will create a watcher that will update and regenerate the localhost test site and allow you to immediately preview changes formatted to HTML.

The newly generated website will be placed in the _site directory.

Look for broken links and correct HTML using html-proofer:

make check

Alerts/Callouts

Callout alerts are available. Use this syntax:

{% include alert type="warning" title="Coming Soon" content="Stay tuned for more details..." %}
  • heading
  • info
  • tip
  • warning
  • danger

ARENA-Related Repositories

minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog