This page documents the core markdown and linking syntax used throughout the vault.
The goal is readability, consistency, and dense interconnection between notes.
Good notes are usually:
Text emphasis should be used sparingly. Over-formatting makes notes harder to scan.
Use double asterisks for strong emphasis.
**important concept**
Example:
important concept
Use single asterisks for softer emphasis, terminology, or tone.
*foreign phrase*
Example:
foreign phrase
Inline code is useful for commands, identifiers, filenames, functions, variables, and technical terminology.
Use `printf()` to write to stdout.
Example:
Use printf() to write to stdout.
Headers define hierarchy and improve navigation.
Use shallow hierarchies whenever possible. Deep nesting usually indicates that a note should be split into multiple pages instead.
# Main page title ## Section ### Subsection #### Detail
A page should normally contain only a single # title at the top.
Internal links are the foundation of the vault.
Instead of organizing information through folders alone, pages should reference related concepts directly. This creates a graph structure rather than a strict tree structure.
[[syntax]]
This creates a direct link to another page.
[[syntax|Markdown syntax]]
Aliases improve readability while preserving stable page names internally.
Internal links are usually preferable to repeating information.
Use standard markdown links for websites and external resources.
[youtube](https://www.youtube.com/)
Example:
External links should generally complement notes rather than replace them.
Lists are useful for sequencing, categorization, and compact information density.
Use ordered lists when sequence matters.
1. First item 2. Second item 3. Third item
Example:
Use unordered lists for grouped concepts where order is irrelevant.
- First item - Second item - Third item
Example:
LaTeX is used for mathematics, statistics, finance, physics, and formal notation.
$E = mc^2$
Example:
$E = mc^2$
Block equations improve readability for larger expressions.
$$
\frac{\partial V}{\partial t} +
\frac{1}{2}\sigma^2 S^2 \frac{\partial^2 V}{\partial S^2} +
rS\frac{\partial V}{\partial S} - rV = 0
$$
Example:
$$ \frac{\partial V}{\partial t} + \frac{1}{2}\sigma^2 S^2 \frac{\partial^2 V}{\partial S^2} + rS\frac{\partial V}{\partial S} - rV = 0 $$
Use fenced code blocks for multiline code snippets.
Language identifiers enable syntax highlighting.
#include <stdio.h> int main() { printf("Hello world!\n"); return 0; }