2021-11-13 22:27:48 +00:00
# The Phyllome OS wiki
This repository contains the articles that together make up the [**Phyllome OS wiki** ](https://wiki.phyllo.me ).
2021-11-14 18:29:36 +00:00
A two-way sync is setup between this repository and the wiki solution, based on [wiki.js ](https://js.wiki/ ).
2021-11-13 22:41:21 +00:00
> Contributions through the wiki web interface are currently only open to [core contributors](https://wiki.phyllo.me/project/join).
2021-11-13 22:27:48 +00:00
## How to contribute
2021-11-14 18:29:36 +00:00
> **Attention please**: Do *not* create new files, as they are not taken into account by `wiki.js` (Or more precisely, I haven't figured that out yet). Please create an issue if you wish to create new pages.
2021-11-13 22:27:48 +00:00
2021-11-13 22:41:21 +00:00
1. **Clone the repository** :
2021-11-13 22:27:48 +00:00
```
git clone https://github.com/PhyllomeOS/wiki/
```
2021-11-13 22:41:21 +00:00
Each page is made out of a header that look like this:
```
---
title: Architecture
description:
published: true
date: 2021-11-12T15:31:49.655Z
tags:
editor: markdown
dateCreated: 2021-11-12T15:31:49.655Z
---
[*You may add some poetry here*]
```
2021-11-14 18:29:36 +00:00
Do not modify this header, but only the content below.
2021-11-13 22:41:21 +00:00
2. **Add or modify content**
Add or modify the content of an *existing page* using your favorite text editor
2021-11-13 22:27:48 +00:00
2021-11-14 18:29:36 +00:00
> Please follow the [CommonMark Spec syntax](https://spec.commonmark.org/). Take a look [here](https://docs.requarks.io/editors/markdown) to see what can be done and how.
2021-11-13 22:27:48 +00:00
2021-11-13 22:41:21 +00:00
3. **Create a pull request**
When you are done, please create a pull request, sit back, and relax.
2021-11-13 22:27:48 +00:00
Thank you!
2021-11-14 18:29:36 +00:00
## License
2021-11-13 22:27:48 +00:00
Contributions are made under a [CC BY 4.0 Licence ](https://creativecommons.org/licenses/by/4.0/ ), for the Phyllome OS Project.
