Free60 wiki - archive
Free60 MediaWiki archive.
mkdocs is used to render the Markdown documentation.
Contributions are very welcome. Here's how you can help:
- Add / correct / expand technical information
- Improve documentation style
- Correct spelling / grammar
- Fix links
- Fork this repo
- Make changes
- Verify your changes are formatted properly
- Send a Pull Request
Step by step instructions
NOTE: The following instructions are targeted towards Unix OS' - needed steps on windows may vary. NOTE 2: You need python3 and python3-venv installed. Please look at your OS' package manager to find the correct packages.
At first: Fork the repository to your account!
Clone the forked repository (change to your actual username)
# SSH git clone email@example.com:<username>/wiki.git or # HTTPS git clone https://github.com/<username>/wiki.git
- Prepare your python virtual environment and dependencies
# Navigate to the cloned repo cd wiki/ # Create a python3 virtual environment in your cloned repository python -m venv venv # Activate the virtual environment source venv/bin/activate
- Install needed python dependencies using python package manager -> pip
pip install mkdocs mkdocs-material
- At this point, load up the clone repository in a text editor that has live-markdown preview function.
- For example: Visual Studio Code. Instructions: (https://code.visualstudio.com/Docs/languages/markdown)
- When you are done, use the following steps to build & preview the documentation / changes locally.
Build the documentation
Serve the documentation
- Once you are happy and the added changes are looking proper, you are ready to submit your work.
Add modified files for commiting
git add docs/<edited_file>.md git add docs/<edited_file_2>.md ...
Create a new commit
git commit # Now in the upcoming editor, describe the changes you made.
Push the changes to your forked repository
- Send a Pull Request :)