Styling Reference
This is a sample README file demonstrating GitHub Flavored Markdown used in Obsidian.
Features
-
Bold and italic text
-
Links to documentation
-
Inline codesnippets -
Code blocks with syntax highlighting:
def hello_world(): print("Hello, world!")
Task List
- [] Incomplete item
Table
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
Callout (Admonition)
Obsidian supports callouts (admonitions) that are compatible with GitHub's rendering:
Note
This is a special callout block.
Specific Obsidian/GitHub Repositories with Samples
You can explore full, realistic samples by checking out these GitHub repositories and loading them as vaults in Obsidian:
- My Sample Obsidian Vault: A personal knowledge management (PKM) vault with real, non-personal notes and folder structures to explore.
- Obsidian Demo: A demo project showing how one user sets up their markdown files.
- DnD 5e SRD in Markdown: A complex example using custom CSS snippets and plugins (like Admonition) for specific use cases.
- Markdown Formatting Guide Gist: A direct
.mdfile you can import into your vault to see various formatting options rendered.
For more specific information on Obsidian's unique features, refer to the Obsidian Help documentation.