Powers the A-Frame Site.
This site is built using hexo. Site content is written in
Markdown (and located in
the src/ directory). Pull requests are welcome!
Clone this repository:
git clone git@github.com:aframevr/aframe-site.git && cd aframe-site
To install the dependencies and start the local development server:
npm install && npm run installdocs && npm start
If you are testing something related to the A-Frame examples, you can set up local configuration settings to point the examples to your local A-Frame examples:
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.
Documentation lives in the A-Frame GitHub repo.
First, clone the A-Frame GitHub repo.
cd aframe
npm link
And then link aframe-site to aframe:
cd aframe-site
npm link aframe
Then the master documentation will update as you work on them from the
A-Frame repository. This works because we have pointed the A-Frame site, via a
soft symbolic link, to the documentation installed in
node_modules/aframe/docs/.
Old versions of documentation are handled through multidep.json. Run npm run bumpdocs to try to pull the latest documentation from GitHub branches (e.g.,
aframevr/aframe#docs-v0.3.0).
Push changes to GitHub, and @a-frobot will automatically deploy the site.
The documentation search is powered by Pagefind, a static search library that generates indexes at build time. No external service or API keys are needed.
For local development, npm run dev generates the Pagefind index via npm run generate:dev. For production, the Pagefind index is generated in the aframevr.github.io repo via .github/workflows/deploy-pages.yml so the index is never committed to git.
Source adopted from Vue's site.
Licensed under The MIT License.