https://github.com/meteor/theme-example
https://github.com/meteor/theme-example
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/meteor/theme-example
- Owner: meteor
- Created: 2018-02-13T23:41:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-18T13:58:39.000Z (over 5 years ago)
- Last Synced: 2025-01-28T23:44:15.898Z (4 months ago)
- Language: JavaScript
- Size: 371 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Test Docs Deployment
This docs deployment is a test [Hexo](https://github.com/hexojs/hexo) theme used by the [`meteor-theme-hexo` (npm) theme](https://github.com/meteor/meteor-theme-hexo) test deployment previews on Netlify.
It can also be used to test theme changes locally!
## Basic Usage
There are two commands, and they use the same arguments which are explained below.
* `npm run build -- `
* This generates the content.
* `npm start -- `
* This generates and also starts a local web server on port 4000.
## Arguments
* `--config-pkg `
* Where `` is a Hexo configuration, such as `apollo-hexo-config`.
* Either this option, or the next option are required.
* `--config-dir `
* Where `` is a local checkout of the configuration.
* Either this option, or the previous option is required.
* `--theme-dir ` (defaults to `meteor-theme-hexo` installed from npm)
## Examples
**For the configuration, use your local checkout which is alongside this theme in `../apollo-hexo-config` along with a local copy of the theme which is alongside in `../meteor-theme-hexo`.
```
npm start -- --config-dir ../apollo-hexo-config --theme-dir ../meteor-theme-hexo
```
**Use the Apollo config from npm, but the local checkout of the theme.
```
npm start -- --config-pkg apollo-hexo-config --theme-dir ../meteor-theme-hexo
```
**Use the (published) Apollo config and the theme, both via npm install.
```
npm start -- --config-pkg apollo-hexo-config
```
**Use the (published) Meteor config and the theme, both via npm install.
```
npm start -- --config-pkg meteor-hexo-config
```