org-press
v0.9.14
Published
Static site generator for org-mode files - like VitePress for org
Maintainers
Readme
org-press
Static site generator for org-mode files — like VitePress for org.
Features
- Org-mode native — Write content in org-mode, render to HTML
- Vite-powered — Fast dev server with HMR
- Code execution — Run code blocks at build time with
:use server - Plugin system — Extend with custom block handlers
- Literate programming — Code and documentation in one file
Installation
npm install org-press
# or
pnpm add org-pressQuick Start
- Create a config file:
// .org-press/config.ts
import type { OrgPressUserConfig } from "org-press";
export default {
contentDir: "content",
outDir: "dist/static",
} satisfies OrgPressUserConfig;- Create content:
#+TITLE: Hello World
* Welcome
This is my first org-press page.
#+begin_src js :use server
const date = new Date().toLocaleDateString();
export default `<p>Generated on ${date}</p>`;
#+end_src- Run dev server:
npx orgp dev- Build for production:
npx orgp buildCLI Commands
orgp dev # Start development server
orgp build # Build for production
orgp serve # Serve built outputDocumentation
Visit orgp.dev for full documentation.
License
GPL-2.0
