exokit-site

Powers the Exokit Site.

This site is built using hexo. Site content is written in Markdown (and located in the src/ directory). Pull requests are welcome!

Local Development

Clone this repository:

git clone git@github.com:exokitxr/exokit-site.git && cd exokit-site

To install the dependencies and start the local development server:

npm install && npm run installdocs && npm start

You can set up local configuration settings:

cp _config.local.yml.dist _config.local.yml

Then load http://localhost:4000/!

You may need to occasionally need to restart the server if you cause breaking changes. Just proceed as usual. When developing on the site scripts, generators, and helpers in scripts/, you will need to restart the server on every change.

Testing Documentation

Documentation lives in the Exokit GitHub repo.

First, clone the Exokit GitHub repo.

cd exokit
npm link

And then link exokit-site to exokit:

cd exokit-site
npm link exokit

Then the master documentation will update as you work on them from the Exokit repository. This works because we have pointed the Exokit site, via a soft symbolic link, to the documentation installed in node_modules/exokit/docs/.

Deployment

Push changes to GitHub, and @exo-bot will automatically deploy the site.

Search

The documentation search service is hosted by Algolia DocSearch. The indexing configuration can be found at the DocSearch config repo.

Credits

Source adopted from the awesome @aframevr site and @vuejs site.

License

Licensed under The MIT License.