Update Readme.md

This commit is contained in:
Ven Gist 2025-04-17 09:01:31 -07:00
parent 4c96512c08
commit e6073329a5
1 changed files with 10 additions and 10 deletions

View File

@ -12,10 +12,10 @@ The knowledge commons is built on simple [markdown](https://www.markdownguide.or
Obsidian provides a nice UI for authoring Markdown content. Obsidian provides a nice UI for authoring Markdown content.
2. Clone and setup the repo https://github.com/oovg/quartz 2. Clone and setup the repo https://github.com/oovg/polycentric
```` ````
``` git clone https://github.com/oovg/quartz ``` git clone https://github.com/oovg/polycentric
``` cd quartz ``` cd quartz
``` yarn ``` yarn
``` yarn quartz build --serve ``` yarn quartz build --serve
@ -23,7 +23,7 @@ The knowledge commons is built on simple [markdown](https://www.markdownguide.or
3. Open the /content folder as a vault in Obsidian 3. Open the /content folder as a vault in Obsidian
Create and Edit content with files and folders within Obsidian Create and Edit content with files and folders within Obsidian
4. Request access to push your updates back to [Github](https://github.com/oovg/quartz). 4. Request access to push your updates back to [Github](https://github.com/oovg/polycentric).
5. Create a pull request from `your-branch-name` to `v4` 5. Create a pull request from `your-branch-name` to `v4`
6. When accepted, your content will be live on the website. 6. When accepted, your content will be live on the website.
@ -31,7 +31,7 @@ The knowledge commons is built on simple [markdown](https://www.markdownguide.or
## Metadata ## Metadata
Each Markdown file should have the following metadata at the top. Each Markdown file can use the following metadata at the top.
``` ```
--- ---
@ -41,7 +41,7 @@ tags: glossary, article, etc
--- ---
``` ```
Example simple glossary entry valid full Markdown file with metadata and content. Example simple glossary entry with complete valid Markdown file with metadata and content.
``` ```
--- ---
@ -62,9 +62,9 @@ https://www.markdownguide.org/cheat-sheet/
### Content Architecture ### Content Architecture
For now we simply have a Glossary and a Reading Room sections for content. Folders create expandable sections of categorized content (files). Feel free to propose new sections of content by adding a new folder
**Glossary:** Create new files, or edit existing ones in the "Glossary" folder For now we have:
**Reading Room:** Add markdown versions of relevant articles, papers, and essays in the "Reading Room" folder to add content here About - general info about the game
Roles - roles and role groups for playing the game
Feel free to propose new sections of content. Sessions - for sharing data around individual sessions