InkStone

Documentation

Complete reference for every InkStone feature. Each topic has its own note — use the index below to jump straight to what you need.


Content & Syntax

Writing and rendering Obsidian-native content.

Topic What it covers
Frontmatter Reference All frontmatter fields and their effects
Wiki-Links [[Note]], aliases, heading anchors, block references
Callouts > [!tip] boxes — types, collapsible, pinned open
Media Embeds Images, video, audio — lightbox, sliders, captions, width
Note Transclusion ![[Note]] — embedding notes or sections inline
Obsidian Syntax Checkboxes, highlights, footnotes, block IDs
Math and Diagrams LaTeX via KaTeX, Mermaid flowcharts and diagrams

Publishing & Structure

How notes become web pages.

Topic What it covers
Post Types homepage, listing, book, and regular posts
Publishing and Privacy website: true, private notes, private placeholders
Navigation Auto-nav, menu_order, breadcrumbs, prev/next, related posts
Tags Frontmatter tags, inline #hashtags, archive pages, tag index
Pagination Listing page size, ?page=N parameter
Attachments _attachments/ folder, resolution order, fallback paths
Multilingual Filename suffix routing, language toggle, UI string translations, session persistence

Finding content across the site.

Topic What it covers
Search Full-text search with tag filter
Dataview TABLE / LIST queries, FROM, WHERE, SORT, GROUP BY, inline
Bases Publish .base database views as filtered, sorted HTML tables
Canvas Publish .canvas files as read-only visual boards

SEO, Feeds & Metadata

Getting found and syndicated.

Topic What it covers
SEO and Metadata OpenGraph, Twitter Card, JSON-LD, banner images, author field
RSS and Sitemap Site-wide and per-section RSS feeds, sitemap.xml

Authoring Workflow

Working with the vault day-to-day.

Topic What it covers
Note Templates QuickAdd and core Templates setup — auto-fill frontmatter on note creation
Multilingual _LANG filename suffix, type: translations for UI labels

Appearance & Developer Experience

Themes, tooling, and the development workflow.

Topic What it covers
Branding Favicon override, site icon, and per-section header title
Themes Dark / light mode toggle, CSS theme files
Code Blocks Syntax highlighting, language labels, copy button
Hot Reload File watching — no server restart needed
Comments Giscus comment system — GitHub Discussions as a backend
Social Links Footer social icons — per-platform keys, auto-extracted handles

All Posts