Notes Syntax Reference

This page is a live reference for everything you can use in a note. All of it is plain markdown — no HTML needed.

Basic markdown

Standard stuff works: bold, italic, strikethrough, inline code, links.

Blockquotes look like this.

Code blocks

Fenced code with a language tag gets syntax-highlighted by Shiki (dark theme):

from langchain_core.tools import tool

@tool
def get_student_curriculum(student_id: str, year: int) -> dict:
    """Fetch CHED-verified curriculum for a BulSU student."""
    return fetch_from_db(student_id, year)

git push origin main  # bantay runs pre-push hook here

Math — inline and block

Inline math with single dollar signs: The Fourier transform of $f(t)$ is $\hat{f}(\xi) = \int_{-\infty}^{\infty} f(t)\, e^{-2\pi i \xi t}\, dt$.

Block (display) math with double dollar signs:

$$\mathbf{H}(j\omega) = \frac{V_{out}}{V_{in}} = \frac{1}{1 + j\omega RC}$$ $$\nabla \cdot \mathbf{E} = \frac{\rho}{\varepsilon_0}, \quad \nabla \times \mathbf{B} = \mu_0 \mathbf{J} + \mu_0\varepsilon_0 \frac{\partial \mathbf{E}}{\partial t}$$

Matrices:

$$A = \begin{pmatrix} a_{11} & a_{12} \\ a_{21} & a_{22} \end{pmatrix}, \quad \det(A) = a_{11}a_{22} - a_{12}a_{21}$$

Mermaid diagrams

Flow charts, sequence diagrams, ER diagrams — all supported.

flowchart TD
    A[Push to git] --> B{bantay pre-push hook}
    B -->|Regex match| C[Block push — secrets found]
    B -->|High entropy, no match| D[Auth0 CIBA approval]
    B -->|Clean| E[Push succeeds]
    D -->|Approved| E
    D -->|Denied / timeout| C

Sequence diagram:

sequenceDiagram
    participant Dev
    participant bantay
    participant Auth0
    participant Remote

    Dev->>bantay: git push
    bantay->>bantay: scan staged files
    bantay->>Auth0: CIBA authorize request (medium risk)
    Auth0-->>Dev: push notification
    Dev-->>Auth0: approve
    Auth0-->>bantay: token
    bantay->>Remote: push proceeds

ER diagram:

erDiagram
    STUDENT ||--o{ ENROLLMENT : has
    COURSE  ||--o{ ENROLLMENT : includes
    STUDENT {
      string student_id PK
      string name
      string program
    }
    COURSE {
      string course_code PK
      string title
      int units
    }
    ENROLLMENT {
      string student_id FK
      string course_code FK
      int semester
      int year
    }

CircuiTikZ diagrams

Circuits are rendered at build time with node-tikzjax (no client WASM — no live-compile strobe). Fence with tikz / circuitikz for a full-width figure:

\usepackage{circuitikz}
\begin{document}
\begin{circuitikz}[american, voltage shift=0.5]
\draw (0,0)
to[isource, l=$I_0$, v=$V_0$] (0,3)
to[short, -*, i=$I_0$] (2,3)
to[R=$R_1$, i>_=$i_1$] (2,0) -- (0,0);
\draw (2,3) -- (4,3)
to[R=$R_2$, i>_=$i_2$]
(4,0) to[short, -*] (2,0);
\end{circuitikz}
\end{document}

A series RC divider:

\usepackage{circuitikz}
\begin{document}
\begin{circuitikz}[american]
\draw (0,0) to[V, v=$V_s$] (0,3)
to[R, l=$R_1$] (3,3)
to[C, l=$C_1$] (3,0) -- (0,0);
\draw (3,3) to[short, -o] (4,3) node[right]{$V_{out}$};
\draw (3,0) to[short, -o] (4,0);
\draw (0,0) node[ground]{};
\end{circuitikz}
\end{document}

Lists and tables

Unordered:

• First item
• Second item
  • Nested item
• Third item

Ordered:

1. Install dependencies
2. Write your note
3. Save — it hot-reloads instantly

Tables:

Plugin	Purpose	Load
remark-math	Parses $...$ and $$...$$	Build
rehype-katex	Renders math → HTML	Build
rehype-tikz + node-tikzjax	Renders tikz / circuitikz → SVG	Build
Mermaid.js	Renders diagram code	Client