mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# Meteor Guide
|
|
|
|
This is a setup to generate a static site from the markdown files location in `/source` using [Hexo](https://hexo.io/).
|
|
|
|
### Notes on Content Authoring
|
|
|
|
- In order for Hexo to pick up the title of a page, each markdown file should provide a `title` field using [YAML front matter](http://jekyllrb.com/docs/frontmatter/). We can optionally include more meta information for each article, e.g. `authors`, if needed.
|
|
|
|
- Use **relative links** when linking to other pages in the guide. This is necessary because we are deploying multiple versions/branches of the site into nested folders.
|
|
|
|
### Theme Development
|
|
|
|
``` bash
|
|
git submodule update --init
|
|
|
|
npm install -g hexo-cli
|
|
|
|
npm install
|
|
# serve at localhost:4000
|
|
hexo server
|
|
```
|
|
|
|
The static site theme is `meteor`, loaded from an npm package, is responsible for the visual representation of the site. For more information, check out the [Hexo docs](https://hexo.io/docs/index.html).
|
|
|
|
### Continuous Deployment
|
|
|
|
- `devel` is automatically deployed as the production site via Netlify.
|
|
|
|
- Any branch that starts with `version-` will be automatically deployed in a sub-folder on every push. A branch with the name `version-1.2` will be deployed under the `v1.2` folder.
|
|
|
|
- To make a branch available in the site's version selection dropdown, make sure to add it to the `versions` list in `_config.yaml`!
|
|
|
|
- Pull Requests will generate deploy previews.
|
|
|
|
- All other branches are ignored.
|
|
|
|
### Manual Deployment
|
|
|
|
In the `site` directory:
|
|
|
|
1. Create `keys.json` (search for "guide_push" in LastPass):
|
|
|
|
``` json
|
|
{
|
|
"key": "xxx",
|
|
"secret": "xxx"
|
|
}
|
|
```
|
|
|
|
2. `node deploy`.
|