diff --git a/docs/03-Formatting/Basic-Markdown-Syntax.md b/docs/03-Formatting/Basic-Markdown-Syntax.md index 2c85c1b..6097f8c 100644 --- a/docs/03-Formatting/Basic-Markdown-Syntax.md +++ b/docs/03-Formatting/Basic-Markdown-Syntax.md @@ -2,7 +2,7 @@ title: Basic-Markdown-Syntax slug: basic-syntax date: 2024-08-11 09:09:46 -update: 2024-08-11 10:48:00 +update: 2024-08-12 09:00:52 publish: "true" tags: - Formatting/Markdown/Basic-Syntax diff --git a/docs/03-Formatting/Extended-Markdown-Syntax.md b/docs/03-Formatting/Extended-Markdown-Syntax.md index fdcc722..585b73f 100644 --- a/docs/03-Formatting/Extended-Markdown-Syntax.md +++ b/docs/03-Formatting/Extended-Markdown-Syntax.md @@ -1,13 +1,14 @@ --- -title: Extended-Syntax +title: Extended-Markdown-Syntax slug: extended-syntax date: 2024-08-11 09:32:57 -update: 2024-08-11 10:22:28 +update: 2024-08-12 09:00:48 publish: "true" tags: - Formatting/Markdown/Extended-Syntax categories: --- + **SOURCE** - [Markdown Cheat Sheet | Markdown Guide](https://www.markdownguide.org/cheat-sheet/) ## Extended Syntax diff --git a/docs/03-Formatting/Github-Flavored-Markdown.md b/docs/03-Formatting/Github-Flavored-Markdown.md index aed0737..e62dbc8 100644 --- a/docs/03-Formatting/Github-Flavored-Markdown.md +++ b/docs/03-Formatting/Github-Flavored-Markdown.md @@ -2,7 +2,7 @@ title: Github-Flavored-Markdown slug: gfm date: 2024-08-11 09:50:39 -update: 2024-08-11 10:34:39 +update: 2024-08-12 09:01:06 publish: "true" tags: - Formatting/Markdown/Github-Flavored @@ -10,7 +10,9 @@ categories: --- **SOURCE** - [⚡️ Full Markdown Example](https://gist.github.com/allysonsilva/85fff14a22bbdf55485be947566cc09e) -## Headers +## Github Flavored Markdown + +### Headers ```markdown # h1 Heading 8-) @@ -29,13 +31,13 @@ Alt-H2 ------ ``` -## H1 Heading 8-) +### H1 Heading 8-) -### H2 Heading +#### H2 Heading -#### H3 Heading +##### H3 Heading -##### H4 Heading +###### H4 Heading ###### H5 Heading @@ -95,7 +97,7 @@ Strikethrough uses two tildes. ~~Scratch this.~~ --- -## Lists +### Lists ```markdown 1. First ordered list item @@ -169,7 +171,7 @@ Strikethrough uses two tildes. ~~Scratch this.~~ --- -## Task Lists +### Task Lists ```markdown - [x] Finish my changes @@ -191,7 +193,7 @@ Strikethrough uses two tildes. ~~Scratch this.~~ --- -## Ignoring Markdown Formatting +### Ignoring Markdown Formatting You can tell GitHub to ignore (or escape) Markdown formatting by using \ before the Markdown character. @@ -203,7 +205,7 @@ Let's rename \*our-new-project\* to \*our-old-project\* --- -## Links +### Links ```markdown [I'm an inline-style link](https://www.google.com) @@ -233,10 +235,10 @@ Some text to show that the reference links can follow later. [I'm an inline-style link with title](https://www.google.com "Google's Homepage") -[I'm a reference-style link][Arbitrary case-insensitive reference text] +[I'm a reference-style link][Arbitrary case-insensitive reference text] %% [I'm a relative reference to a repository file](../blob/master/LICENSE) -%% +%% [You can use numbers for reference-style link definitions][1] Or leave it empty and use the [link text itself]. @@ -253,7 +255,7 @@ Some text to show that the reference links can follow later. --- -## Images +### Images ```markdown Here's our logo (hover to see the title text): @@ -311,7 +313,7 @@ With a reference later in the document defining the URL location: --- -## Footnotes +### Footnotes ```markdown Footnote 1 link[^first]. @@ -339,7 +341,7 @@ Duplicated footnote reference.[^2] --- -## Code and Syntax Highlighting +### Code and Syntax Highlighting ```markdown Inline `code` has `back-ticks around` it. @@ -459,7 +461,7 @@ datahere --- -## Tables +### Tables ```markdown Colons can be used to align columns. @@ -549,7 +551,7 @@ Markdown | Less | Pretty --- -## Blockquotes +### Blockquotes ```markdown > Blockquotes are very handy in email to emulate reply text. @@ -579,7 +581,7 @@ Quote break. --- -## Inline HTML +### Inline HTML ```markdown
@@ -591,7 +593,7 @@ Quote break.
``` -## Horizontal Rules +### Horizontal Rules ```markdown Three or more… @@ -625,7 +627,7 @@ Underscores --- -## YouTube Videos +### YouTube Videos ```markdown @@ -647,4 +649,4 @@ Underscores and multiple paragraphs. -[^2]: Footnote text. \ No newline at end of file +[^2]: Footnote text. diff --git a/docs/03-Formatting/Obsidian-Advanced-Formatting.md b/docs/03-Formatting/Obsidian-Advanced-Formatting.md index 716cb14..6352241 100644 --- a/docs/03-Formatting/Obsidian-Advanced-Formatting.md +++ b/docs/03-Formatting/Obsidian-Advanced-Formatting.md @@ -2,7 +2,7 @@ title: Obsidian-Advanced-Formatting slug: obsidian-advanced date: 2024-08-11 10:45:25 -update: 2024-08-11 11:09:36 +update: 2024-08-12 09:01:17 publish: "true" tags: - Formatting/Markdown/Obsidian/Advanced @@ -10,9 +10,11 @@ categories: --- **SOURCE** - [Advanced formatting syntax - Obsidian Help](https://help.obsidian.md/Editing+and+formatting/Advanced+formatting+syntax) +## Obsidian Advanced Formatting + Learn how to add advanced formatting syntax to your notes. -## Tables +### Tables You can create table using vertical bars (`|`) and hyphens (`-`). Vertical bars separate columns, and hyphens define the column header. @@ -39,7 +41,7 @@ Max | Planck Marie | Curie ``` -### Format Content within a Table +#### Format Content within a Table You can use [[Obsidian-Basic-Formatting]] to style content within a table. @@ -54,7 +56,6 @@ You can use [[Obsidian-Basic-Formatting]] to style content within a table. > > If you want to use aliases, or to resize an image in your table, you need to add a `\` before the vertical bar. - ```md > First column | Second column > -- | -- @@ -73,7 +74,7 @@ Left-aligned text | Center-aligned text | Right-aligned text :-- | :--: | --: Content | Content | Content -## Diagram +### Diagram You can add diagrams and charts to your notes, using [Mermaid](https://mermaid-js.github.io/). Mermaid supports a range of diagrams, such as [flow charts](https://mermaid.js.org/syntax/flowchart.html), [sequence diagrams](https://mermaid.js.org/syntax/sequenceDiagram.html), and [timelines](https://mermaid.js.org/syntax/timeline.html). @@ -114,7 +115,7 @@ graph TD Biology --> Chemistry ``` -### Linking Files in a Diagram +#### Linking Files in a Diagram You can create internal links in your diagrams by attaching the `internal-link` [class](https://mermaid.js.org/syntax/flowchart.html#classes) to your nodes. @@ -167,7 +168,7 @@ This way, each letter node becomes an internal link, with the [node text](https: For more information about creating diagrams, refer to the [official Mermaid docs](https://mermaid.js.org/intro/). -## Math +### Math You can add math expressions to your notes using [MathJax](http://docs.mathjax.org/en/latest/basic/mathjax.html) and the LaTeX notation. @@ -197,4 +198,4 @@ This is an inline math expression $e^{2i\pi} = 1$. For more information about the syntax, refer to [MathJax basic tutorial and quick reference](https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference). -For a list of supported MathJax packages, refer to [The TeX/LaTeX Extension List](http://docs.mathjax.org/en/latest/input/tex/extensions/index.html). \ No newline at end of file +For a list of supported MathJax packages, refer to [The TeX/LaTeX Extension List](http://docs.mathjax.org/en/latest/input/tex/extensions/index.html). diff --git a/docs/03-Formatting/Obsidian-Basic-Formatting.md b/docs/03-Formatting/Obsidian-Basic-Formatting.md index 8fedea7..564ef53 100644 --- a/docs/03-Formatting/Obsidian-Basic-Formatting.md +++ b/docs/03-Formatting/Obsidian-Basic-Formatting.md @@ -2,7 +2,7 @@ title: Obsidian-Basic-Formatting slug: obsidian-basic date: 2024-08-11 10:44:54 -update: 2024-08-12 05:47:18 +update: 2024-08-12 09:01:30 publish: "true" tags: - Formatting/Markdown/Obsidian/Basic @@ -10,9 +10,11 @@ categories: --- **SOURCE** - [Basic formatting syntax - Obsidian Help](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax) +## Obsidian Basic Formatting + Learn how to apply basic formatting to your notes, using [Markdown](https://daringfireball.net/projects/markdown/). For more advanced formatting syntax, refer to [[Obsidian-Advanced-Formatting]]. -## Paragraphs +### Paragraphs To create paragraphs, use a blank line to separate one or more lines of text. @@ -41,7 +43,7 @@ This is another paragraph. > > If you want to add multiple spaces, you can add ` ` (blank space) and `
` (newline) to your note. -## Headings +### Headings To create a heading, add up to six `#` symbols before your heading text. The number of `#` symbols determines the size of the heading. @@ -63,7 +65,7 @@ To create a heading, add up to six `#` symbols before your heading text. The num
This is a heading 5
This is a heading 6
-## Bold, Italics, Highlights +### Bold, Italics, Highlights Text formatting can also be applied using Editing shortcuts. @@ -90,14 +92,14 @@ Formatting can be forced to display in plain text by adding a backslash `\` in f \**This line will be italic and show the asterisks*\* ``` -## Internal Links +### Internal Links Obsidian supports two formats for internal links between notes: - Wikilink: `[[Three laws of motion]]` - Markdown: `[Three laws of motion](Three%20laws%20of%20motion.md)` -## External Links +### External Links If you want to link to an external URL, you can create an inline link by surrounding the link text in brackets (`[ ]`), and then the URL in parentheses (`( )`). @@ -113,7 +115,7 @@ You can also create external links to files in other vaults, by linking to an Ob [Note](obsidian://open?vault=MainVault&file=Note.md) ``` -### Escape Blank Spaces in Links +#### Escape Blank Spaces in Links If your URL contains blank spaces, you must escape them by replacing them with `%20`. @@ -127,7 +129,7 @@ You can also escape the URL by wrapping it with angled brackets (`< >`). [My Note]() ``` -## External Images +### External Images You can add images with external URLs, by adding a `!` symbol before an external link. @@ -152,7 +154,7 @@ If you only specify the width, the image scales according to its original aspect > [!tip] > If you want to add an image from inside your vault, you can also embed an image in a note. -## Quotes +### Quotes You can quote text by adding a `>` symbols before the text. @@ -169,7 +171,7 @@ You can quote text by adding a `>` symbols before the text. > [!tip] > You can turn your quote into a callout by adding `[!info]` as the first line in a quote. -## Lists +### Lists You can create an unordered list by adding a `-`, `*`, or `+` before the text. @@ -195,7 +197,7 @@ To create an ordered list, start each line with a number followed by a `.` symbo 2. Second list item 3. Third list item -### Task Lists +#### Task Lists To create a task list, start each list item with a hyphen and space followed by `[ ]`. @@ -222,7 +224,7 @@ You can toggle a task in Reading view by selecting the checkbox. > - [?] Eggs > - [-] Eggs -### Nesting Lists +#### Nesting Lists All list types can be nested in Obsidian. @@ -256,7 +258,7 @@ Similarly, you can create a nested task list by indenting one or more list items Use `Tab` or `Shift+Tab` to indent or unindent one or more selected list items for easy organization. -## Horizontal Rule +### Horizontal Rule You can use three or more stars `***`, hyphens `---`, or underscore `___` on its own line to add a horizontal bar. You can also separate symbols using spaces. @@ -274,11 +276,11 @@ _ _ _ *** -## Code +### Code You can format code both inline within a sentence, or in its own block. -### Inline Code +#### Inline Code You can format code within a sentence using single backticks. @@ -290,7 +292,7 @@ Text inside `backticks` on a line will be formatted like code. If you want to put backticks in an inline code block, surround it with double backticks like so: inline ``code with a backtick ` inside``. -### Code Blocks +#### Code Blocks To format a block of code, surround the code with triple backticks. @@ -335,7 +337,7 @@ Obsidian uses Prism for syntax highlighting. For more information, refer to [Sup > [!note] > Source mode and Live Preview do not support PrismJS, and may render syntax highlighting differently. -## Footnotes +### Footnotes You can add footnotes[^1] to your notes using the following syntax: @@ -357,7 +359,7 @@ You can also use inline footnotes. ^[This is an inline footnote.] > [!note] > Inline footnotes only work in reading view, not in Live Preview. -## Comments +### Comments You can add comments by wrapping text with `%%`. Comments are only visible in Editing view.