https://github.com/alephium/docs
Everything about Alephium
https://github.com/alephium/docs
alephium documentation docusaurus
Last synced: 5 months ago
JSON representation
Everything about Alephium
- Host: GitHub
- URL: https://github.com/alephium/docs
- Owner: alephium
- Created: 2022-03-13T21:05:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-01-23T13:28:40.000Z (5 months ago)
- Last Synced: 2026-01-24T05:35:49.920Z (5 months ago)
- Topics: alephium, documentation, docusaurus
- Language: JavaScript
- Homepage: https://docs.alephium.org
- Size: 33.6 MB
- Stars: 12
- Watchers: 4
- Forks: 49
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alephium Docs
Built using [Docusaurus 2](https://docusaurus.io/).
## Development
Install dependencies:
```shell
npm i
```
Start dev server:
```shell
npm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Build
```shell
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Internationalization (i18n)
You are welcome to submit translations of the docs pages. So far we only have a small portion of the docs translated to French. We currently only have capacity to review the following languages:
- French
- German
- Swedish
- Turkish
If your translation is a mere Google translation without any correction, the Pull Request will likely not be accepted.
**Before you begin translating, please consider your submission as _commitment_ to maintain the pages in sync with any changes happening in the English version**
### Enable a new language for translation
1. Find the ISO 689-1 two-letter code for your language [here](https://www.loc.gov/standards/iso639-2/php/English_list.php)
2. Create a folder for the documents inside the `i18n` folder. For example german: `mkdir -p i18n//docusaurus-plugin-content-docs/current` (_note that you will need to replace `` with the actual two-letter international code_).
3. Copy all the content from `/docs` into the new folder: `cp -r docs/ i18n//docusaurus-plugin-content-docs/current/` (_again, note that you will need to replace `` with the actual two-letter international code_).
4. Remove all the `_category_.json` files from the subfolders inside `i18n//docusaurus-plugin-content-docs/current`: `find i18n//docusaurus-plugin-content-docs/current -type f -name "_category_.json" -exec rm {} \;`
5. Build the translation files for the navbar and the footer: `npm run write-translations -- --locale `.
Now you can start translating any and all files in `i18n//docusaurus-plugin-content-docs/current`
To test your content, run the following command: `npm run start -- --locale `
This will only load the wiki in the language you are translating. To locally test the whole site, you can do `npm run build && npm run serve`)