Mastering Starknet. By the Starknet community
This repository contains the source for The Starknet Book.
Every contribution, regardless of its size, plays a pivotal role in refining this work. Together, we advance the Starknet narrative.
cargo install mdbook --version 0.4.31 && cargo install mdbook-i18n-helpers --version 0.1.0
sudo apt install gettext
.brew install gettext
to install.git clone https://github.com/starknet-edu/starknetbook && cd starknetbook
.@gianalarcon
or @omarespejel
).npm i
npm run format
prettier --write .
The Starknet Book is optimized for mdBook:
src/SUMMARY.md
: The book's structural outline. For adding chapters, modify this document.src/
: This directory holds individual chapters. Each is a markdown file, like ch35.md
. Use subdirectories for added resources.book.toml
: The primary configuration file (regular contributors might not need to adjust this).Ensure all edits to Markdown files are in English.
mdbook serve
to initiate a local server. Access the book at localhost:3000 or append --open
to the command to launch a browser automatically: mdbook serve --open
.Targeting a global readership, this book will undergo translations over time.
src
directory in English. This consistency allows for smooth auto-translation../translations.sh es
. Without specifying a language, only English translations get extracted.po/es.po
. Tools like poedit can be beneficial.po/xx.po
file. When opening a PR, start with the prefix i18n
.The translation work is inspired from Comprehensive Rust repository.
For starting translations in a new language:
./translations.sh new xx
, replacing xx
with your language code. This action generates a language file.xx.po
file, use ./translations.sh xx
.xx.po
file already exists (which means you are not initiating a new translation).Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!