diff --git a/knowledge base/dnf.md b/knowledge base/dnf.md index b131dc8..d98f7c9 100644 --- a/knowledge base/dnf.md +++ b/knowledge base/dnf.md @@ -142,7 +142,7 @@ Alternative could be to exclude the packages from one or more repositories or du Not to mention, - acting on the repository files requires the `exclude` configuration key to be set for every repository the package could be found in; -- using the `--exclude` CLI option requires the option to be given at every run. +- using the `--exclude` CLI option requires the option to be given at every run. ## Further readings diff --git a/knowledge base/markdown.md b/knowledge base/markdown.md index d450420..db12852 100644 --- a/knowledge base/markdown.md +++ b/knowledge base/markdown.md @@ -4,7 +4,9 @@ ReadMe's Markdown engine. ## Table of contents +1. [TODO list](#todo-list) 1. [Folded content](#folded-content) +1. [Images](#images) 1. [Diagrams](#diagrams) 1. [Flow chart A.K.A. graph](#flow-chart-aka-graph) 1. [Sequence diagram](#sequence-diagram) @@ -12,12 +14,23 @@ ReadMe's Markdown engine. 1. [State diagram](#state-diagram) 1. [Gantt diagram](#gantt-diagram) 1. [Pie chart](#pie-chart) +1. [Math](#math) 1. [Troubleshooting](#troubleshooting) 1. [Escape the backtick character](#escape-the-backtick-character) 1. [VS Code and mermaid graph in Markdown preview](#vs-code-and-mermaid-graph-in-markdown-preview) 1. [Further readings](#further-readings) 1. [Sources](#sources) +## TODO list + +Use `[ ]` after the bullet point or numbered list character to switch them for an empty ballot box, and `[x]` for a checked one. + +1. [ ] 1 +1. [ ] 2 + - [x] a + +- [x] Point 3 + ## Folded content Use a `
` HTML tag: @@ -29,6 +42,27 @@ Use a `
` HTML tag:
``` +## Images + +Add an image: + +```md +![description](path/to.image) +![description][reference name] +``` + +Control width and height: + +```md + +``` + +Align in the center: + +```md +
![sleep-cat](./cat.png)
+``` + ## Diagrams See [mermaid.js], [The magical Markdown I bet you don't know] and [slaise/High-level-Markdown]. @@ -41,7 +75,7 @@ Code blocks for diagrams can either: ### Flow chart A.K.A. graph ```md -:::mermaid +:::mermaid graph LR A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} @@ -55,7 +89,7 @@ graph LR ::: ``` -```mermaid +```mermaid graph LR A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} @@ -210,6 +244,16 @@ pie title Pets adopted by volunteers "Rats" : 15 ``` +## Math + +```md +$\sum_{n=1}^{10} n^2$ +$$\sum_{n=1}^{10} n^2$$ +``` + +$\sum_{n=1}^{10} n^2$ +$$\sum_{n=1}^{10} n^2$$ + ## Troubleshooting ### Escape the backtick character @@ -228,19 +272,21 @@ Install and enable [`bierner.markdown-mermaid`][bierner.markdown-mermaid]'s exte ## Further readings - Official [documentation] +- [Extended syntax] - [Linguist supported language syntax list] ## Sources All the references in the [further readings] section, plus the following: -- [Escaping Backticks] +- [Escaping backticks] - [Escaping backtick in Markdown] - [The magical Markdown I bet you don't know] - [slaise/High-level-Markdown] [documentation]: https://docs.readme.com/rdmd/docs +[extended syntax]: https://www.markdownguide.org/extended-syntax/ [mermaid.js]: mermaid.js.md