Skip to content

Nyarch Wiki

The Nyarch Linux wiki is designed to be a straightforward and accessible resource for users of all skill levels, particularly those new to Nyarch Linux. Unlike the comprehensive Arch Wiki, the Nyarch Linux Wiki focuses on providing simpler, easy-to-understand information on various topics. Additionally, it offers Nyarch-specific guidance and recommendations to help you enhance your experience with Nyarch Linux.

What goes in this wiki

  • Simple tutorials and suggestions for beginners
  • Simplified explainations about Linux and Arch Linux (easier than the Arch Wiki, but also provide links to it)
  • Nyarch-specific usage suggestions

What does not go in this wiki

  • Server things
  • Advanced or dangerous topics
  • Detailed techincal explainations

Contributing to the Wiki

You can contribute to the wiki on GitHub. To contribute to the wiki, log in into your github account and visit our repository.

The wiki is built using Mkdocs.

All the content files are in docs/. To create a new page, create a markdown file in that folder and add it to the index in the mkdocs.yml file.

You can choose if to clone the whole repo on your computer using git, or to edit the wiki directly from GitHub WebUI.

Contributing to the Wiki from Github WebUI

First of all, fork the wiki using the button on the top part of the github page.

immagine

After the fork is created, you can edit the files directly from the Github WebUI by opening it and clicking on the pencil icon.

immagine

Here you can make changes and preview them.

immagine

After you have done the appropriate changes, click on commit changes and write a summary of what you have modified. immagine

After that, click on "X commits ahead of..." to open a Pull Request

immagine

Create a pull request and explain all of your changes. We will review your changes, ask for appropriate modifications and accept them.

Deploying the wiki

Firstly, clone the wiki:

git clone https://github.com/NyarchLinux/NyarchWiki

Install mkdocs and mkdocs-material in a python venv

python -m venv venv
source venv/bin/activate
pip install mkdocs mkdocs-material

Launch the wiki:

mkdocs serve