-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #57 from Ultramarine-Linux/w/readme-i18n
feat: update readme
- Loading branch information
Showing
1 changed file
with
13 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,18 @@ | ||
# Ultramarine Linux Wiki | ||
|
||
This wiki is meant to be the extended documentation for both end users and developers, so it is separated in those two categories. Made with Astro and a modification of the default blog template. | ||
Welcome to the source repository behind the [Ultramarine Wiki]! We welcome any contributions and | ||
you may freely send pull requests to this repository if you would like to modify any of the | ||
content here! | ||
|
||
## 🧞 Commands | ||
## Translations | ||
|
||
All commands are run from the root of the project, from a terminal: | ||
If you'd like to translate for a new language: | ||
|
||
| Command | Action | | ||
| :---------------------- | :----------------------------------------------- | | ||
| `pnpm install` | Installs dependencies | | ||
| `pnpm run dev` | Starts local dev server at `localhost:3000` | | ||
| `pnpm run build` | Build your production site to `./dist/` | | ||
| `pnpm run preview` | Preview your build locally, before deploying | | ||
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` | | ||
| `pnpm run astro --help` | Get help using the Astro CLI | | ||
1. Go to `src/consts.ts` to add a new language into `KNOWN_LANGUAGES` | ||
2. Copy everything from `src/content/docs/en` to `src/content/docs/<your_language_code>`[^1] | ||
3. Add pages into `SIDEBAR` in `src/consts.ts` | ||
4. Start translating! | ||
|
||
[^1]: We encourage you to use a generic language code without limiting the region. | ||
|
||
[Ultramarine Wiki]: https://wiki.ultramarine-linux.org |