Skip to content

Commit 3c47e23

Browse files
Update: Formatting Guidelines (workaround)
Changed backslash escape characters to backticks around escaped `#` and `[[ ]]`, as these are not escaped per Quartz issue jackyzha0/quartz#593
1 parent 859e1af commit 3c47e23

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

content/MMW Design & Planning/Manual of Style - 36 Sermons of MMW/Formatting Guidelines.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,11 @@ Inline code should not be used to denote keyboard buttons, e.g., `ctrl`. Instead
4040

4141
Code blocks support [syntax highlighting](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Code+blocks) by defining code language after the first three backticks, e.g.,
4242

43-
\`\`\`lua
44-
\`\`\`
43+
````
44+
```lua
45+
46+
```
47+
````
4548

4649
#### Supported Languagss
4750

@@ -61,7 +64,6 @@ These include:
6164
- titles
6265
- line highlighting and word highlighting
6366
- line numbers
64-
- escaping codeblocks
6567

6668
As these features are not part of Obsidian, they will not be rendered there. However, The community plugin [Shiki Highlighter](https://github.com/mProjectsCode/obsidian-shiki-plugin) can be used to enable rendering of these.
6769

@@ -123,26 +125,26 @@ Headers structure content to help readers navigate your article.
123125

124126
> [!abstract]+ Headers
125127
>
126-
> ## \#\# This is a main subject (h2)
128+
> ## `##` This is a main subject (h2)
127129
>
128-
> ### \#\#\# This subject has several important sub-subjects (h3)
130+
> ### `###` This subject has several important sub-subjects (h3)
129131
>
130-
> #### \#\#\#\# Sub-subjects can benefit from subheadings (h4)
132+
> #### `####` Sub-subjects can benefit from subheadings (h4)
131133
>
132-
> ##### \#\#\#\#\# Example (h5)
134+
> ##### `#####` Example (h5)
133135
>
134-
> ```
135-
> [example code block]
136+
> ```lua title="codeblock title"
137+
> example code block
136138
> ```
137139
138140
**Header 1** (H1) should never be used, as a webpage should only ever contain one H1 element - in Quartz, the article filename is the H1 element (i.e., **Wiki Formatting Guidelines**)
139141
140-
| Markdown | HTML Header Tag Equivalent | Use |
141-
| ----------------- | -------------------------- | ------------------------------------------------- |
142-
| \# | `<h1>` | Unused, as Quartz uses the filename as h1 |
143-
| \#\# | `<h2>` | Main section divider |
144-
| \#\#\# - \#\#\#\# | `<h3>` - `<h4>` | For use in article subsections |
145-
| \#\#\#\#\# | `<h5>` | For labeling _'Example'_ above fenced code blocks |
142+
| Markdown | HTML Header Tag Equivalent | Use |
143+
| ------------------ | -------------------------- | ----------------------------------------- |
144+
| `#` | `<h1>` | Unused, as Quartz uses the filename as h1 |
145+
| `##` | `<h2>` | Main section divider |
146+
| `###` - `####` | `<h3>` - `<h4>` | For use in article subsections |
147+
| `#####` - `######` | `<h5>` - `<h6>` | (use-case undetermined yet) |
146148
147149
Header numbers should be arranged sequentially.
148150
@@ -201,7 +203,7 @@ Links are important for navigating content in the wiki.
201203
>
202204
> An 'internal link' is a link from one page in MMW to another page in MMW.
203205
>
204-
> These should be rendered using \[\[Wikilink\]\] format as detailed on [Internal Links - Obsidian Help](https://help.obsidian.md/Linking+notes+and+files/Internal+links)
206+
> These should be rendered using `[[Wikilink]]` format as detailed on [Internal Links - Obsidian Help](https://help.obsidian.md/Linking+notes+and+files/Internal+links)
205207
206208
> [!info]+ External Links
207209
>

0 commit comments

Comments
 (0)