seemore

Let AI write the Markdown. Let seemore show it better — zero config documentation framework.

Website · Report Bug · Request Feature

AI tools write Markdown — specs, notes, guides, READMEs, whole folders of it, faster than anyone can read. A pile of .md files is write-only memory: nothing to click, nothing to search, no order.

seemore points at that folder and renders it as a proper site instead, without you moving a single file or writing any code.

Three ways to use it:

• In your browser: npx seemore serves the folder you're standing in and updates live as you edit.
• In your code editor: an extension puts the same site in a panel next to the file you're editing — VS Code and VS Code-compatible editors like Cursor and Antigravity.
• As a static site: npx seemore build exports plain HTML you can host anywhere, so it doubles as a docs framework, not just a preview tool.

And whichever preview is open, the page is also an editor: double-click any paragraph to fix its Markdown in place, and the change is written straight back to the file.

Features

• Zero config — no config file, no code, no files to move; a plain folder of Markdown works in the browser, in your editor, and as a static build
• Live preview — add, rename, retitle or delete a file and the site updates immediately, navigation and search included
• Edit in place — double-click any block in the preview to fix its Markdown; saves are surgical, so git diff shows the sentence you changed and nothing else
• Full MDX — when Markdown isn't enough, .mdx pages take real JSX: your own React components, inline SVG, custom classes and CSS; <Callout>, <Card>, <CodeBlockTabs> and friends come built in, with no imports to write
• Static export — seemore build prerenders every page to its own HTML file, 404.html included, and adds the conventions individual hosts look for (_redirects, 200.html, .nojekyll)
• Search built in — static, zero-setup full-text search out of the box, with shareable highlighted results; Algolia and Orama Cloud for hosted indexes
• 12 themes — dark and light follow the system, with a toggle that remembers your choice; your own CSS always wins
• Rich Markdown — GitHub Flavoured Markdown, admonitions, steps, [[wikilinks]], Mermaid and D2 diagrams, click-to-zoom images, embedded PDFs
• First-class code blocks — build-time Shiki highlighting in the theme's own colours, with titles, line numbers, diff markers and focus
• Editor integration — one extension covers VS Code, Cursor, Antigravity and other VS Code-compatible editors, remote workspaces included

View in your browser

npx seemore     # view the current folder in your browser, live, no setup

Run it in your folder of Markdown files (Node.js 20 or newer) and open the address it prints — http://localhost:4040 by default. From there it's live: add, rename, retitle or delete a file and the site updates immediately. Point it at a subfolder with npx seemore docs if that's where your files live.

Edit your files from the browser

The preview is not just for reading — it is the fastest way to fix what you are reading. Double-click any paragraph, heading, list item, quote or table cell and it opens in a small editor holding that block's Markdown source: **bold** stays **bold**, links stay links, tables stay tables. Fix the text and hit Save and the change is written to the file on disk.

Inline editing is for local previews only — seemore build output is static, so nothing is emitted there. It is on by default in dev; switch it off with the ! prefix:

export default {
  features: ['!content.edit'],
};

View in your code editor

Install seemore from the VS Code Marketplace or Open VSX to get the same rendered site as a panel beside your editor — no terminal, no npx, no browser tab to manage. The extension bundles the CLI, so nothing is downloaded or put on your PATH. Open VSX also covers VS Code-compatible editors — Cursor, Antigravity, and others.

1. Open any Markdown file.
2. Click the seemore icon in the editor's title bar, or right-click a folder in the explorer and choose Open Folder in seemore.
3. The rendered site opens beside your editor, scoped to that file's folder.

Commands

Settings

Publish it to the web

npx seemore build  # static export to dist/ for any host

The result is a dist/ folder of plain web files: drop it on Netlify, Surge, Cloudflare Pages or GitHub Pages, or hand it to any web host. Every page is prerendered to its own index.html, next to a 404.html that every static host honours. On top of that, the small conventions individual hosts look for — _redirects for Netlify and Cloudflare Pages, 200.html for Surge, .nojekyll for GitHub Pages — are written for you.

[!TIP] Project sites on GitHub Pages live under username.github.io/my-repo/, not the root, so set base once: base: '/my-repo/' (or --base /my-repo/ on the CLI). Building under GitHub Actions without it set prints the exact line to add.

Configuration

Optional — a folder with no config file builds correctly everywhere. To adjust things, create seemore.config.ts next to your content:

// seemore.config.ts
export default {
  title: 'My Docs',
  description: 'Everything about the thing.',
  favicon: './favicon.svg',
  base: '/my-repo/',
  theme: 'ocean',
  css: './custom.css',
  features: ['navigation.path', 'navigation.instant.preview'],
  nav: [{ text: 'GitHub', link: 'https://github.com/you/repo' }],
  footer: { text: '© 2026' },
  editLink: { base: 'https://github.com/you/repo/edit/main/docs' },
  search: 'static', // or { provider: 'orama-cloud', endpoint, apiKey } / { provider: 'algolia', appId, apiKey, indexName }
  exclude: ['drafts/**'],
};

Search

The default search: 'static' needs no setup, no server and no account: the index is built from your Markdown and queried in the browser, in a Web Worker. search.suggest completes your query inline, and search.highlight carries the query onto the page you land on (?h=…), so search-result links are shareable. Hosted indexes are a drop-in swap whenever you want one: Orama Cloud (@orama/core) or Algolia (algoliasearch), each needing nothing but its SDK installed.

Themes

Twelve built-in colour presets: neutral (default), black, catppuccin, dusk, ocean, purple, ruby, solar, aspen, emerald, vitepress, shadcn. For anything else, put your own CSS in css; it's appended last, so it wins. Dark and light follow your system setting, with a toggle that remembers your choice — black is built for dark mode, shown below with the toggle on.

neutral (default)	black

catppuccin	dusk

ocean	purple

ruby	solar

aspen	emerald

vitepress	shadcn

Features

A flat list of switches for fine control, set as an array on the features key. Turn something on by adding its flag name, turn something off with the ! prefix; flags you don't mention keep their default.

// seemore.config.ts
export default {
  features: [
    'navigation.path',              // off by default → this turns it on
    '!navigation.instant.prefetch', // on by default → this turns it off
  ],
};

Combinations that can't work together raise a config error naming both flags and the fix.

Content

Supports .md and .mdx both.

• GitHub Flavoured Markdown, admonitions (note / tip / warning boxes), step-by-step lists, and colour-highlighted code blocks
• [[wikilinks]], including [[Page|label]] and [[Page#Heading]], the easiest way for you or your AI to link pages without relative paths to get right
• Relative .md links are resolved to working links automatically
• Mermaid and D2 diagrams, both rendered live in the browser straight from a ```mermaid or ```d2 code fence
• Sibling images inlined as hashed assets with click-to-zoom, sibling PDFs open in the browser's own viewer
• Frontmatter keys are validated

Code blocks

Code is syntax-highlighted automatically — nothing to configure. Add a filename or line numbers by putting them after the language on the fence line:

const port = 4040;

You can also highlight a line, mark it as added/removed, or focus it, with a comment right in the code — // [!code highlight] and friends. See it all rendered live, with the full list of options, on the Content page.

Components

.mdx files can use <Callout>, <Card>, <Cards>, <CodeBlockTabs>, <Mermaid>, <D2> and <Pdf> with no imports needed — plain .md files just keep the tag as text, so components need the .mdx extension. Full syntax for each is on the Content page.

Numbered headings — ## 1. Install it, ## 2. Point it at a folder — become a numbered sequence.

Page addresses

Ordering

Pages are ordered by:

1. meta.json in the directory — an explicit list, with ... standing in for anything you didn't name:

   { "pages": ["getting-started", "installation", "..."] }
   

2. Frontmatter order — lower numbers first:

   ---
   title: Getting Started
   order: 1
   ---
   

3. Alphabetical by title, for anything left unordered by the two above

CLI reference

seemore [dir]           start the dev server
seemore build [dir]     build a static site into dist/

Options
  --port <number>        dev server port (default 4040)
  --host [host]          expose the dev server on the network
  --open / --no-open     open a browser on start (default: no)
  --json                 print one machine-readable JSON line instead of the summary (dev only)
  --config <path>        path to seemore.config.ts
  --out <dir>            build output directory (default: dist)
  --base <path>          subpath the site is served from, e.g. /my-repo/
  -h, --help             show this message
  -v, --version          show the version

Under the hood

fumadocs provides the interface presets, with Shiki, Mermaid, D2, Vite and React Router underneath. The code editor extension runs the same CLI as a child process it manages. Bug reports and pull requests are welcome at github.com/arifszn/seemore.

Licence

MIT