This repository contains the source code of our wiki page.
- bun - Run a local copy of the website to preview local changes
- git - Avoid editing files from GitHub Web as much as possible. See here to get started on using git.
- A text editor - Ideally one that parses markdown correctly.
- Fork this repository so you have your own copy of this repository.
- Clone the forked repository to your computer.
git clone https://github.com/<your-username>/wiki
- To commit your changes, create a new branch. Do not commit directly to the master branch, regardless of whether it's your own fork.
git checkout -b <new-branch>
-
Now you can start editing the files you see fit.
-
Commit your changes.
git add <modified-files> # Alternatively you can use git add -A for all files or git add -u for untracked files
git commit # For a simple commit message, you can do git commit -m "Commit Message"
git push origin <new-branch>
bun install # Install dependencies used by our wiki
bun run dev # Runs a local copy of the wiki, complete with your modifications!
Finally, you can open a pull request to get your changes reviewed and hopefully merged.
Happy contributing!
We are always open to community members adding new translations to the wiki. This helps immensely for non-English speakers.
Firstly, you need to add your language to the list of available locales to the site. This is done in astro.config.mjs
.
Please refer to the ISO 639-1 list of language codes.
// astro.config.mjs
export const locales = {
root: {
label: 'English',
lang: 'en',
},
xx: {
label: 'Your Language',
lang: 'xx', // Refer to two-letter language codes from the ISO 639-1 list linked above.
},
};
Next, you can start adding your own translations. To do this, add a subdirectory to src/content/docs
with your two-letter language code.
├── astro.config.mjs
├── src
│ └── content
│ └── docs
│ ├── cachyos_basic
│ │ ├── download.mdx
│ │ └── why_cachyos.md
│ └── xx # Your language code
│ └── cachyos_basic
│ ├── download.mdx
│ └── why_cachyos.md
└── tsconfig.json
Now you can start adding your own translations!.
As a final step, you want your translated page to be indexed, this is done again in our astro.config.mjs
// astro.config.mjs
{
label: 'Why CachyOS?',
translations: {
xx: '<why-cachyos-in-yourlanguage>',
},
link: 'cachyos_basic/why_cachyos',
},
Please refer to our basic guide for comitting and pushing changes. When you're done, you can open a pull request
Happy translating!