Quickstart
Get started with CodeInk in less than 60 seconds. No account required, no installation needed.CodeInk runs entirely in your browser. Your documents are stored locally and never sent to any server.
Create your first document
Open the editor
Navigate to the documents page or click “Get started” from the homepage.When you open CodeInk for the first time, a new document is automatically created with example content showing all major features.
src/scripts/editor.ts
Each document gets a unique UUID stored in the URL hash (e.g.,
/editor#abc-123-def). Bookmark the URL to return to your document later.Write some Markdown
Start typing in the left pane. The preview updates in real-time on the right.Try this example:
Add syntax highlighting
CodeInk automatically highlights code blocks using Shiki, the same engine that powers VS Code.Supported languages include:
- JavaScript, TypeScript, JSX, TSX
- Python, Rust, Go, Java, Kotlin
- HTML, CSS, SCSS, Tailwind
- SQL, GraphQL, YAML, JSON, TOML
- Bash, Docker, Terraform, HCL
- And 16+ more
Create a diagram
Add a Mermaid diagram to visualize your ideas. CodeInk renders diagrams in real-time.Try this flowchart:Or try a sequence diagram:
Mermaid supports 15+ diagram types including flowcharts, sequence diagrams, ER diagrams, Gantt charts, class diagrams, state diagrams, and more.
Add math equations
Use KaTeX to render LaTeX math expressions.For inline math, use single dollar signs:For display math, use double dollar signs:Try adding this matrix multiplication:
Switch view modes
Use the view mode buttons at the top of the editor to change the layout:
- Editor: Full-width editor (great for writing)
- Split: Side-by-side editor and preview (default)
- Preview: Full-width preview (great for reading)
src/scripts/view-mode.ts
On mobile devices (width < 640px), CodeInk automatically defaults to editor-only mode.
Managing documents
All your documents are listed on the documents page. Here’s what you can do:View all documents
Documents are sorted by last modified date (most recent first). Each card shows:- Document title (extracted from first heading)
- Content preview (first 100 characters)
- Last modified time (relative, e.g., “2h ago”)
src/scripts/documents.ts
Rename a document
Hover over a document card and click the pencil icon. Type a new title (max 20 characters) and press Enter.src/scripts/documents.ts
Delete a document
Hover over a document card and click the trash icon. Confirm the deletion in the browser prompt.src/scripts/documents.ts
Deleted documents cannot be recovered. CodeInk does not have a trash or recycle bin.
Create a new document
Click the “Create new document” button on the documents page. CodeInk generates a unique UUID and loads the editor with example content.Using markdown linting
CodeInk includes real-time Markdown linting powered by remark-lint.View lint diagnostics
Lint issues appear as:- Wavy underlines in the editor
- A count in the status bar (e.g., “3 issues”)
Auto-fix issues
Click the “Fix” button in the status bar to automatically fix common issues:- Missing spaces after heading markers (e.g.,
#Heading→# Heading) - Inconsistent list markers
- Inconsistent emphasis markers
- Extra blank lines
src/scripts/markdown-linter.ts
Keyboard shortcuts
CodeInk leverages CodeMirror 6’s built-in keyboard shortcuts:| Shortcut | Action |
|---|---|
Cmd/Ctrl + B | Bold selection |
Cmd/Ctrl + I | Italic selection |
Cmd/Ctrl + Z | Undo |
Cmd/Ctrl + Shift + Z | Redo |
Cmd/Ctrl + F | Find |
Cmd/Ctrl + H | Find and replace |
Tab | Indent line/selection |
Shift + Tab | Outdent line/selection |
CodeMirror automatically handles most common editing operations. Full keyboard shortcut documentation is available in the CodeMirror 6 docs.
Privacy and data storage
CodeInk is designed with privacy as a core principle:100% client-side
All Markdown processing, rendering, and storage happens in your browser. No data is ever sent to a server.
IndexedDB storage
Documents are stored in your browser’s IndexedDB. They persist across sessions but are limited to one browser.
No tracking
Zero analytics, zero cookies, zero tracking scripts. CodeInk doesn’t know you exist.
No accounts
No signup, no login, no passwords. Your documents are tied to your browser, not to an account.
Storage limits
Clearing data
To delete all CodeInk data:- Open browser DevTools (F12)
- Go to Application → Storage
- Find “IndexedDB” → “codeink-docs”
- Right-click and select “Delete database”
Next steps
Now that you know the basics, explore more features:Mermaid diagrams
Learn all Mermaid diagram types with examples
KaTeX math
Master LaTeX math syntax for equations and formulas
Document management
Learn how to organize and manage your documents
GitHub repository
Contribute to CodeInk or report issues