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!")
Markdown:
---
dg-publish: false
---
# Theme Customizations
Documents all modifications to the default Digital Garden / Obsidian base theme so they can be re-applied if the theme is updated by the plugin.
## 1. Custom Styles
**File:** `src/site/styles/custom-style.scss`
This file is not overwritten by plugin updates — safe to edit freely.
### Font
Overrides the Obsidian base theme's system-font stack with Inter. The `!important` is required to win the CSS variable cascade. Inter is already bundled in `obsidian-base.scss` via `@font-face`.
```scss
body {
--font-default: 'Inter', sans-serif!important;
}
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.