mdx-pages
v0.1.2
Published
Build an MDX directory into a single-page static site using Vite
Downloads
6
Readme
MDX Pages
MDX Pages is a Vite-based MD/MDX directory viewer that renders a folder of documents as a single-page site.
Features
- Supports both
.mdand.mdxfiles - Auto-generates navigation from folder structure
- GitHub-style Markdown rendering
- Dark theme by default
- Lazy loading for better performance
Usage
1. Preview a directory
You can run the CLI directly without installing dependencies:
npx mdx-pages <inputDir>Or with other package managers:
yarn dlx mdx-pages <inputDir>
pnpm dlx mdx-pages <inputDir>
bunx mdx-pages <inputDir>Example:
npx mdx-pages ./docs2. Show only SKILL.md files
- When
--skill(alias-s) is used without aninputDir, it defaults to:~/.agents/skills
npx mdx-pages --skill- You can also specify a custom skills directory:
npx mdx-pages ~/.codex/skills --skill3. Use a custom port
npx mdx-pages ./docs --port 5174