Markdown formatting

Basic formatting Syntax

Basic formatting syntax

Paragraphs

If you want to prevent spaces from collapsing or add multiple blank spaces, you can use the   (non-breaking space) or <br> (line break) HTML tags.

Footnotes

You can add footnotes¹ to your notes using the following syntax:

This is a simple footnote[^1].
 
[^1]: This is the referenced text.
[^2]: Add 2 spaces at the start of each new line.
  This lets you write footnotes that span multiple lines.
[^note]: Named footnotes still appear as numbers, but can make it easier to identify and link references.

You can also inline footnotes in a sentence. Note that the caret goes outside the brackets.

You can also use inline footnotes. ^[This is an inline footnote.]

You can also use inline footnotes. ^[This is an inline footnote.]

Note

Inline footnotes only work in reading view, not in Live Preview.

Comments

You can add comments by wrapping text with % by using it twice. Comments are only visible in Editing view.

Testing out a … (inline comment), which is hidden.

This is an  (inline) comment where the word inline is enclosed with % twice.
 
Below is a block comment, which is hidden in view mode.

Obsidian Flavored Markdown

Syntax	Description	Example
`[[Link]]`	Internal links
`![[Link]]`	Embed files
`![[Link\#^id]]`	Block references
`^id`	Defining a block	Obsidian Obsidian AI-ML-DS-and-SE Glossary
“	Comments
`~~Text~~`	Strikethroughs
`==Text==`	Highlights
```	Code blocks
`- [ ]`	Incomplete task
`- [x]`	Completed task
`> [!note]`	Callouts
(see link)	Tables

Callouts

Callouts

Supported callout types

> [!note]
> [!abstract]
- Aliases: summary, tldr
> [!info]
> [!todo]
> [!tip]
- Aliases: hint, important
> [!success]
- Aliases: check, done
> [!question]
- Aliases: help, faq
> [!warning]
- Aliases: caution, attention
> [!failure]
- Aliases: fail, missing
> [!danger]
- Aliases: error
> [!bug]
> [!example]
> [!quote]
- Aliases: cite

Nested callouts

> [!question] Can callouts be nested?
> 
> > [!todo] Yes!, they can.
> > > [!example]  You can even use multiple layers of nesting.

Foldable callouts

 > [!note]- Foldable
 > This is a foldable callout

Plugins

https://quartz.jzhao.xyz/plugins/ObsidianFlavoredMarkdown - Need to revisit this, and explore deeper for Block references (https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link%20to%20a%20block%20in%20a%20note)
LongForm - Helps to create long projects. Need to revisit this to understand its features properl

Updating the Site

Key commands

Building the quartz
- This will start a local web server to run our Quartz on our computer. We can view it at http://localhost:8080/

npx quartz build --serve

Sync the change to Github & Deploy
- Run tis command every time we want to push updates to our repository.

npx quartz sync

Upgrading Quartz
- To fetch the latest Quartz updates, simply run

npx quartz update

For more details, refer Quartz 4.0 official documentation

Customising the site

Open Graph Meta Tags
- Preview and generate using this site: https://www.opengraph.xyz/url/https%3A%2F%2Fprasanth.io
Line wrap in source mode of when editing table entry
- Solution provided in Obsidian forum

Obsidian References

Site Inspirations

Tutorials & Youtube Videos

How to publish your notes for free with Quartz
- The youtube video that I referred to publish my Obsidian notes using Quartz plugin and Github Pages for 🆓
“Obsidian” Canvas on STEROIDS: Excalidraw 1.9.5 release

Documentations

Quartz 4.0
- The documentation I referred to publish my Obsidian notes for free with Quarts

Non-obsidian Site Inspirations

http://saratchandranagavarapu.rf.gd/index.html

This is the referenced text. ↩

Prasanth Thangavel

Explorer

Obsidian - The best personal knowledge management (PKM) tool