Overview
Start here for the docs structure, what is implemented today, and where to go once the file gets serious.
Read this when the editor starts getting interesting.
Noteism is a Rust-built hybrid editor that makes Markdown genuinely beautiful — one place for writing, thinking, and refining.
These docs are for the real app that exists now: hybrid editing, source mode, tables, Mermaid, themes, exports, workspace browsing, and enough knobs to get yourself into productive trouble.
No vapor-doc theater
Everything linked below maps to features that are already in the app or to release behavior that already exists in the project. If a thing is still a plan, the docs say so plainly.
Pick the shortest path to useful
Installation
Real install paths, platform notes, source builds, and the current packaging truth without fake certainty.
Getting Started
First-run flow, hybrid editing behavior, source mode, and the controls worth learning first.
Markdown Features
What Noteism already renders and edits: lists, tables, callouts, code, math, Mermaid, links, emoji, and more.
Navigation & Tools
Find and replace, TOC jumps, workspace browsing, the output log, and other things that keep long docs sane.
Exports
Pandoc-based export targets, PDF behavior, previous-export flows, and where export settings actually live.
Themes
JSON theme structure, color tokens, import behavior, user theme folders, and the connection to themes.noteism.app.
Contributing
Where to send patches, docs work, bug reports, and testing help without wasting everybody's time.
What is actually in the app right now
| Area | Already landed |
|---|---|
| Editing model | Hybrid inline editing plus full-document source mode |
| Markdown coverage | Headings, lists, tasks, callouts, code, tables, math, Mermaid, images, TOC, footnotes |
| Navigation | TOC sidebar, find/replace, file browser, context menus, tabs |
| Preferences | Session restore, fonts, line numbers, default workspace, hidden files, theming, export defaults |
| Export | HTML, PDF, DOCX, ODT, RTF, EPUB, LaTeX, Reveal.js, MediaWiki, CommonMark, GFM, and more |
| Diagnostics | Output log with timestamps, levels, copy actions, clear action, and persistence |
How to read the docs
Start with Installation, then jump to Getting Started and Markdown Features. That gives you the actual editing model before you fall into the preferences rabbit hole.
Read Themes after installation. The app already loads JSON
themes at runtime, supports import, and tracks light/dark appearance metadata.
If you want the browser-side tooling too, bounce to themes.noteism.app.
Read Contributing and Navigation & Tools. The codebase is broad, the test suite is large, and the fastest way to help is understanding how the editor, workspace tools, and docs surfaces fit together.
Current map
Noteism is not trying to be a toy preview pane with a fake writer costume on it. It is a real desktop editor with real document tooling, and the docs should earn that tab the same way the app earns its window.