Starknet documentation repository

Welcome to the Starknet Docs repository, written in AsciiDoc and built using Antora.

To build and preview content locally, first:

1. Install yarn if it’s not already installed.

2. Install npx if it’s not already installed.

3. Clone this repo, either from a fork or directly from starknet-io/starknet-docs (if you are an official collaborator).

4. Nativgate into the starknet-docs directory and run the yarn command to prepare the environment:

   cd starknet-docs && yarn

Then:

1. Build the content with Antora:

   npx antora playbook.yml

   generating the website in the public_html directory.

2. Run the http server packaged with Antora:

   npx http-server public_html -c-1

   giving you one or more local URLs that you can use to view the website, e.g.:

   Starting up http-server, serving public_html
   
   ...
   
   Available on:
     http://127.0.0.1:8080
     http://192.168.68.111:8080
     http://192.168.14.3:8080
     http://10.14.0.2:8080
   Hit CTRL-C to stop the server

After writing or editing content, rebuild it to preview your changes (rerunning the server is not necessary).