RICOH THETA Plug-in community guide.
Switch branches/tags
Nothing to show
Clone or download
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.
docs
theme/material
.gitignore
README.md
mkdocs.yml

README.md

THETA Plug-in Community Guide

This document is viewable here:

http://theta360.guide/plugin-guide/

Fast Viewing Docs for Review by Contributors

You can also view the MarkDown docs directly on GitHub in a web browser. The images and formatting will be automatically displayed by GitHub.

Status

As of April 30, 2018, this guide is partially updated for the new API and SDK

Building the HTML from MarkDown

  • install MkDocs
  • install material theme pip install mkdocs-material

Create HTML from MarkDown

$ mkdocs build

Editing Documents

Edit the *.md files in ./docs/ only. Do not edit the HTML files in ./site. The HTML files will be overwritten by mkdocs build.

Workflow to edit docs and view from local server

$ mkdocs serve

Theme

We are using a modified Material Design theme. Another theme can be specified in mkdocs.yml.