⚠️Early Alpha — Org-press is experimental. Perfect for hackers and tinkerers, not ready for production. Documentation may be incomplete or inaccurate.

Shared Options

These options apply to both development and production builds.

contentDir

  • Type: string
  • Default: "content"

Directory containing your .org files. All org files in this directory (and subdirectories) will be processed.

export default {
  contentDir: "content",
};

The directory structure is preserved in the output. For example:

content/
├── index.org        → /index.html
├── guide/
│   └── intro.org    → /guide/intro.html
└── api/
    └── types.org    → /api/types.html

outDir

  • Type: string
  • Default: "dist/static"

Output directory for production build. Created by orgp build.

export default {
  outDir: "dist/static",
};

The output contains fully static HTML files that can be deployed to any static host.

base

  • Type: string
  • Default: "/"

Base public path for the site. Set this when deploying to a subdirectory.

// Deployed to https://example.com/docs/
export default {
  base: "/docs/",
};

All asset URLs and internal links will be prefixed with this base path.

Environment-Based Base

export default () => ({
  base: process.env.BASE_URL || "/",
});

cacheDir

  • Type: string
  • Default: "node_modules/.org-press-cache"

Directory for build cache and generated intermediate files. Contains:

  • Compiled block outputs
  • Virtual module cache
  • Type definitions
export default {
  cacheDir: "node_modules/.org-press-cache",
};

You can safely delete this directory to force a full rebuild. It will be regenerated automatically.

See Also