Skip to content

Commit 7516ab9

Browse files
Update MMW Design & Planning pages:
- Added 'Shiki Highlighter' to Obsidian plugins for consideration - Added 'Factorio Wiki' and 'RimWorld Wiki' to website examples
1 parent 3c47e23 commit 7516ab9

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

content/MMW Design & Planning/Obsidian Plugins for Consideration.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ tags:
33
- MMW-Development
44
description: This is a list of Obsidian community plugins that could be integrated into the workflow of the wiki.
55
---
6+
67
This is a list of Obsidian community plugins that could be integrated into the workflow of the wiki. Preferably these should be plugins which are compatible as-is with Quartz. However, some plugins that are not currently compatible with Quartz will also be listed for consideration.
78

89
## [Linter](https://github.com/platers/obsidian-linter)
@@ -84,5 +85,22 @@ Dataview generates _data_ from your vault by pulling information from **Markd
8485
>
8586
> Quartz integration is possible, but convoluted. The rewards may not be worth the effort involved to get it running.
8687
88+
---
89+
90+
## [Shiki Highlighter](https://github.com/mProjectsCode/obsidian-shiki-plugin)
8791
92+
This plugin integrates [shiki](https://shiki.style/) via [Expressive Code](https://expressive-code.com/) into Obsidian, providing better syntax highlighting for over 100 languages.
8893
94+
Shiki is [used by Quartz for syntax highlighting](https://quartz.jzhao.xyz/features/syntax-highlighting) and adds a number of additional ways to style codeblocks.
95+
96+
> [!abstract] Use-Case:
97+
>
98+
> Enables Shiki-style syntax highlighting in Obsidian, aligning its rendering of codeblocks with Quartz. This improves WYSIWYG.
99+
100+
> [!success] Compatible with Quartz
101+
>
102+
> Quartz already uses Shiki, so this plugin would help align how codeblocks are rendered in Obsidian with how they are rendered in Quartz.
103+
104+
> [!warning] Cons
105+
>
106+
> The plugin uses [Expressive Code](https://expressive-code.com/) for rendering, whereas Quartz uses [Rehype Pretty Code](https://rehype-pretty-code.netlify.app/).

content/MMW Design & Planning/Quartz and Wiki Website Examples.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,28 @@ Created with Gitbook, this is the modding wiki for Cyberpunk 2077
7676

7777
The home of [Paradox Interactive](https://www.paradoxinteractive.com/) game wikis. Most (if not all) wikis hosted on Paradox Wikis contain an extensive **Modding** section detailing how to create and manage mods for the game in question.
7878

79-
---
80-
8179
### [Souls Modding](http://soulsmodding.wikidot.com/)
8280

8381
The 'Soulsborne Modding Wiki' is the home of modding knowledge of FromSoftware's ['Soulsborne'](https://en.m.wikipedia.org/wiki/Soulslike)' games.
8482

8583
The structure appears to be that of a general reference wiki, with tutorials separated into their own section and each tutorial attributed to a specific author.
8684

87-
---
88-
8985
### [Stardew Modding Wiki](https://stardewmodding.wiki.gg/wiki/Main_Page)
9086

9187
The modding wiki for 'Stardew Valley'.
9288

93-
---
89+
### [Factorio Wiki](https://wiki.factorio.com/Modding)
90+
91+
The 'Factorio Wiki' has a substantial section on modding.
92+
93+
### [RimWorld Wiki](https://rimworldwiki.com/wiki/Main_Page)
94+
95+
This wiki has a modestly-sized modding section, but three articles are particularly noteworthy for their clear and concise layout.
96+
97+
- [Basic Melee Weapon](https://rimworldwiki.com/wiki/Modding_Tutorials/Basic_Melee_Weapon)
98+
- [Basic Ranged Weapon](https://rimworldwiki.com/wiki/Modding_Tutorials/Basic_Ranged_Weapon)
99+
- [Basic Plant](https://rimworldwiki.com/wiki/Modding_Tutorials/Basic_Plant)
100+
101+
They offer a clear model for how MMW tutorial articles could be structured. The section headings 'Goals', 'Recommended Reading' and 'Sample Repository' act as a clear preamble to prepare users to follow the tutorial.
94102

103+
In addition, formatting the main tutorial content as a table is a bold choice - in the left column is the `code` the tutorial is based on, and in the right column is the author's annotations. To implement this in MMW presents CSS formatting challenges, but is doable. The first challenge is that a codeblock cannot be entered in a table in Markdown, only `inline code`. A simple workaround is to place the table in another note, then embed the note section as a block into the table

0 commit comments

Comments
 (0)