You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
1.4 KiB

# README for the documentation site
## Building after a fork
## Run locally
To run locally:
1. Get the content from the downstream repos.
```
./get-content.sh
```
3. Build and serve locally.
```
bundle exec jekyll serve --config _config.yml,staticman.yml
```
Use this format to turn on production features:
```
JEKYLL_ENV=production bundle exec jekyll serve --config _config.yml
```
## Deploy via Netlify
To deploy to Netlify:
1. Build the site.
```
JEKYLL_ENV=production bundle exec jekyll build --config _config.yml
```
2. Force add the `_site` directory.
```
git push -f origin
```
## Test a Deploy with Surge
```
cd _site
surge
```
```
surge --domain raspy-songs.surge.sh
```
# To generate the CLI json manually
The `_data/cliRef.json` file is generated from the `blockstack-cli` subcommand `docs`. This data file is consumed by the `_includes/commandline.md` file which is used to serve up the reference.
1. Install the latest version of the cli.
```
$ npm install -g https://github.com/blockstack/cli-blockstack
```
2. Generate the json for the cli in the `docs.blockstack1 repo.
```
$ blockstack-cli docs | python -m json.tool > _data/cliRef.json
```
3. Make sure the generated docs are clean.
# Technology Reference
* [UIKit](https://getuikit.com/docs/grid)
* [Liquid templates](https://shopify.github.io/liquid/)