From 383e54d438ad8bcec5fc8616accb2ed40425432f Mon Sep 17 00:00:00 2001 From: Lukas Date: Sat, 13 Nov 2021 23:41:21 +0100 Subject: [PATCH] Refine instructions --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 615eda0..fe9e9d4 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,47 @@ This repository contains the articles that together make up the [**Phyllome OS wiki**](https://wiki.phyllo.me). -A two-ways sync is setup between this repository and the wiki solution, based on [wiki.js](https://js.wiki/). Contributions through the wiki web interface are currently only open to [core contributors](https://wiki.phyllo.me/project/join). +A two-ways sync is setup between this repository and the wiki solution, based on [wiki.js](https://js.wiki/). + +> Contributions through the wiki web interface are currently only open to [core contributors](https://wiki.phyllo.me/project/join). ## How to contribute -> **Attention please**: Do *not* create new files, as they are not taken into account by `wiki.js`. Please create an issue if you wish to create new pages. +> **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. -* Clone the repository: +1. **Clone the repository**: ``` git clone https://github.com/PhyllomeOS/wiki/ ``` -* Add or modify some contents to an *existing page* using your favorite text editor. +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*] +``` + +Do not modify this header, but only the content bellow. + + +2. **Add or modify content** + +Add or modify the content of an *existing page* using your favorite text editor > Please follow the [CommonMark Spec syntax](https://spec.commonmark.org/). Have a look [here](https://docs.requarks.io/editors/markdown) to see what can be done and how. -* Create a pull request when you are done, sit back, and relax. +3. **Create a pull request** + +When you are done, please create a pull request, sit back, and relax. Thank you!