GithubHelp home page GithubHelp logo

caseyyee / aframe-site Goto Github PK

View Code? Open in Web Editor NEW

This project forked from aframevr/aframe-site

0.0 0.0 0.0 131.59 MB

Official A-Frame site.

Home Page: https://aframe.io/

License: MIT License

Makefile 0.01% JavaScript 99.36% HTML 0.26% CSS 0.38%

aframe-site's Introduction

aframe-site

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!

Local Development

To install the dependencies and start the local development server:

npm install && npm start

Then load http://localhost:4000/!

You may need to occasionally need to resart the server if you cause breaking changes. Just proceed as usual.

Writing Documentation

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.

Deployment

To deploy this to production (GitHub Pages):

npm run deploy

It will now be live!

Credits

Source adopted from the awesome @vuejs site.

License

Licensed under The MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.