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.
 
 

1.4 KiB

Gitpod ready-to-code

Stacks documentation

A screenshot of docs.blockstack.org

Running and building the site locally

If you are interested in contributing to the site and making changes, please refer to our contributing guide here.

Generated documentation

Style checks

This repository uses vale to run style checks. Make sure to install the tool and run the following command before creating a PR in order to check for styling issues:

yarn check:style

Blockstack CLI reference

The src/_data/cli-reference.json file is generated from the stx subcommand docs.

  1. Install the latest version of the cli according to the instructions at: https://github.com/blockstack/stacks.js/tree/master/packages/cli

  2. Generate the json for the cli in the docs.blockstack repo.

    stx docs > src/_data/cli-reference.json
    

Clarity Reference

There is a json file that is generated via the stacks-blockchain repo, which automatically brings it over to this repo via a github action.

FAQs

All of the FAQs found at /reference/faqs are pulled dynamically from the zendesk api and rendered in this project.