mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
chore: improved markdown article and syntax
This commit is contained in:
@@ -1,5 +1,14 @@
|
||||
# Markdown
|
||||
|
||||
ReadMe's Markdown engine.
|
||||
|
||||
## Table of contents <!-- omit in toc -->
|
||||
|
||||
1. [Troubleshooting](#troubleshooting)
|
||||
1. [Escape the backtick character](#escape-the-backtick-character)
|
||||
1. [Further readings](#further-readings)
|
||||
1. [Sources](#sources)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Escape the backtick character
|
||||
@@ -11,8 +20,26 @@ Render it in an inline code block using double backticks instead of single backt
|
||||
Alternatively, use a code block. This will wrap everything in a `<pre>` HTML tag.
|
||||
To do this, either indent 4 spaces to start a code block, or use fenced code blocks if supported.
|
||||
|
||||
## Further readings
|
||||
|
||||
- Official [documentation]
|
||||
- [Linguist supported language syntax list]
|
||||
|
||||
## Sources
|
||||
|
||||
All the references in the [further readings] section, plus the following:
|
||||
|
||||
- [Escaping Backticks]
|
||||
- [Escaping backtick in Markdown]
|
||||
|
||||
<!-- project's references -->
|
||||
|
||||
<!-- internal references -->
|
||||
|
||||
[documentation]: https://docs.readme.com/rdmd/docs
|
||||
|
||||
<!-- external references -->
|
||||
|
||||
[escaping backtick in markdown]: https://www.growingwiththeweb.com/2015/06/escaping-backtick-in-markdown.html
|
||||
[escaping backticks]: https://www.markdownguide.org/basic-syntax/#escaping-backticks
|
||||
[linguist supported language syntax list]: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
|
||||
|
||||
Reference in New Issue
Block a user