meteor/docs

Name: docs

Owner: Meteor

Description: The Meteor API documentation.

Created: 2012-09-21 03:22:09.0

Updated: 2018-01-15 15:56:49.0

Pushed: 2018-01-13 17:52:52.0

Homepage: https://docs.meteor.com/

Size: 4170

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Meteor API Documentation - http://docs.meteor.com

This is a hexo static site used to generate the Meteor API Docs.

Contributing

We'd love your contributions! Please send us Pull Requests or open issues on github. Also, read the contribution guidelines.

If you are making a larger contribution, you may need to run the site locally:

Running locally

Submodules

This repo has two submodules, one the theme, the other full Meteor repository.

We have the Meteor repo to generate the data.js file (see below).

After cloning, or updating the repo, it makes sense to run

submodule update --init

Generally you should not commit changes to the submodules, unless you know what you are doing.

Generating data.js

To generate the api boxes, the site uses a file data/data.js which is generated from the js docs in the Meteor source code. This will automatically happen whenever you start your local hexo server.

Starting hexo

Ensure you've run npm install. Then simply npm start.