Mary Anthony
9a2d63fac7
|
5 years ago | |
---|---|---|
_android | 5 years ago | |
_browser | 5 years ago | |
_common | 5 years ago | |
_community | 5 years ago | |
_core | 5 years ago | |
_data | 5 years ago | |
_develop | 5 years ago | |
_faqs | 5 years ago | |
_includes | 5 years ago | |
_ios | 5 years ago | |
_layouts | 6 years ago | |
_org | 5 years ago | |
_plugins | 6 years ago | |
_posts | 6 years ago | |
_sass | 6 years ago | |
_storage | 5 years ago | |
assets | 5 years ago | |
exclude | 6 years ago | |
news | 6 years ago | |
.gitignore | 6 years ago | |
404.md | 6 years ago | |
Gemfile | 6 years ago | |
Gemfile.lock | 6 years ago | |
Guardfile | 6 years ago | |
README.md | 5 years ago | |
THEME_README.md | 6 years ago | |
_config.yml | 5 years ago | |
_redirects | 6 years ago | |
changelog.md | 6 years ago | |
collections.json | 6 years ago | |
contact.md | 6 years ago | |
get-content.sh | 6 years ago | |
history.png | 6 years ago | |
index.md | 6 years ago | |
overview_auth.md | 6 years ago | |
package-lock.json | 5 years ago | |
package.json | 6 years ago | |
robots.txt | 6 years ago | |
staticman.yml | 6 years ago | |
thanks.md | 6 years ago |
README.md
README for the documentation site
Building after a fork
Run locally
To run locally:
-
Get the content from the downstream repos.
./get-content.sh
-
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:
-
Build the site.
JEKYLL_ENV=production bundle exec jekyll build --config _config.yml
-
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.
-
Install the latest version of the cli according to the instructions at: https://github.com/blockstack/cli-blockstack
-
Generate the json for the cli in the
docs.blockstack
repo.$ blockstack-cli docs | python -m json.tool > _data/cliRef.json
-
Make sure the generated docs are clean by building the documentation.
If you run into any problem in the generation usually it results from a problem in the repo. You can make a pull request back to the repo to fix anything.
Clarity Reference
As of 8/12/19 Clarity is in the develop branch of core. You can build the Clarity command line from the Docker image. core/src/vm/docs/mod.rs
-
Pull the latest developer preview from the Docker Hub.
$ docker pull blockstack/blockstack-core:clarity-developer-preview
-
Build the lastest JSON.
docker run -it -v $HOME/blockstack-dev-data:/data/ blockstack/blockstack-core:clarity-developer-preview blockstack-core docgen | jsonpp > ~/repos/docs.blockstack/_data/clarityRef.json
-
Build the documentation and verify the Clarity reference is building correctly.