https://github.com/starknet-io/starknet-docs
The repo for Starknet's developer documentation. Includes contribution guidelines and the Starknet documentation supplementary style guide
https://github.com/starknet-io/starknet-docs
contributions-welcome documentation starknet styleguide
Last synced: 3 months ago
JSON representation
The repo for Starknet's developer documentation. Includes contribution guidelines and the Starknet documentation supplementary style guide
- Host: GitHub
- URL: https://github.com/starknet-io/starknet-docs
- Owner: starknet-io
- Created: 2022-01-24T10:18:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:15:24.000Z (7 months ago)
- Last Synced: 2024-10-29T09:32:30.262Z (7 months ago)
- Topics: contributions-welcome, documentation, starknet, styleguide
- Language: AsciiDoc
- Homepage: https://docs.starknet.io/
- Size: 242 MB
- Stars: 132
- Watchers: 6
- Forks: 182
- Open Issues: 9
-
Metadata Files:
- Readme: README.adoc
- Changelog: CHANGELOG.md
- Contributing: contributing_to_docs/doc_guidelines.adoc
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[id="readme"]
= Starknet documentation repository
Welcome to the https://docs.starknet.io[Starknet Docs^] repository, written in https://asciidoc.org/[AsciiDoc^] and built using https://antora.org/[Antora^].
To build and preview content locally, first:
. Install `yarn` if it's not already installed.
. Install `npx` if it's not already installed.
. Clone this repo, either from a fork or directly from `starknet-io/starknet-docs` (if you are an official collaborator).
. Nativgate into the `starknet-docs` directory and run the `yarn` command to prepare the environment:
+
----
cd starknet-docs && yarn
----
Then:
. Build the content with Antora:
+
[source,bash]
----
npx antora playbook.yml
----
+
generating the website in the `public_html` directory.
. Run the http server packaged with Antora:
+
[source,bash]
----
npx http-server public_html -c-1
----
+
giving you one or more local URLs that you can use to view the website, e.g.:
+
[source,bash,subs="+quotes,+macros"]
----
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).