Welcome
A living reference — condensed from research blog posts, maintained alongside active work. Short, dense, code-first.
Adding a flat note
Two steps — a content file and a nav entry.
- Create
content/notes/<slug>.mdxwith atitlein the frontmatter. - Add a
NavPageentry toNOTES_NAVinlib/notes-nav.ts.
---
title: "OSINT"
---
Your note content here.export const NOTES_NAV: NavItem[] = [
{ title: 'Welcome', slug: 'welcome' },
{ title: 'OSINT', slug: 'osint' }, // ← new flat note
]Adding a section (group label)
Sections are non-clickable labels that visually group pages in the sidebar. Use a NavSection object with a section string and a pages array.
{
section: 'Reconnaissance',
pages: [
{ title: 'Passive Recon', slug: 'recon/passive' },
{ title: 'OSINT', slug: 'recon/osint' },
],
},ℹ Slugs with folders Use recon/passive as the slug and create the file at content/notes/recon/passive.mdx. Velite handles nested directories automatically.
Adding a page group with children
A page group is a note that also has child notes nested beneath it in the sidebar. The parent is fully clickable and holds its own content. Children collapse/expand via the › chevron.
- Create the parent MDX file as normal.
- Create each child MDX file at
content/notes/<parent>/<child>.mdx. - Add a
NavPageGroupentry — a page object with achildrenarray.
{
section: 'Web',
pages: [
{
title: 'SQL Injection',
slug: 'sqli',
children: [
{ title: 'MySQL', slug: 'sqli/mysql' },
{ title: 'MSSQL', slug: 'sqli/mssql' },
{ title: 'PostgreSQL', slug: 'sqli/postgres' },
],
},
],
},File layout on disk:
content/notes/
├── sqli.mdx # parent note
└── sqli/
├── mysql.mdx
├── mssql.mdx
└── postgres.mdxContent conventions
- Keep notes short and dense — this is a reference, not an essay.
- Code blocks use the same syntax highlighting as research posts.
- Section headers (
##) get automatic anchor links. - Use
## Overviewas the first heading for parent notes that introduce a topic. - Child notes should be entirely self-contained — assume the reader landed directly.
Available components
All MDX components from the research posts are available in notes.
Callout
⚠ Warning — Use for critical caveats, dangerous commands, or timing-sensitive steps.
ℹ Note — Use for supplementary context that doesn't interrupt the main flow.
✔ Good — Use for patches, mitigations, or positive outcomes.
Inline tags
IP addresses: 10.10.10.42 · CVE IDs: CVE-2024-12345 · Ports: :4444
<IP>10.10.10.42</IP>
<CVE>CVE-2024-12345</CVE>
<Port>:4444</Port>
<Callout type="note">your text</Callout>