package
Beautiful Website for Your Projects
npm install doculaGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
docula.config.ts (TypeScript) or docula.config.mjs (JavaScript) file to customize the build process with lifecycle hooks and DoculaConsole logging.feed.xml for your site.llms.txt and llms-full.txt for LLM-friendly indexing of docs, API reference, and changelog content.variables.css with no template editing required.You can build Docula as a standalone binary that runs without Node.js installed. This uses Node.js Single Executable Applications (SEA) to embed the runtime and all dependencies into a single executable.
Requires Node.js >= 25.7.0 to build (the resulting binary does not need Node.js to run). The build uses tsdown's exe option, which wraps Node.js's Single Executable Applications feature added in Node 25.7.
pnpm install
pnpm build:binaryThis produces a platform-specific binary at dist/docula (or dist/docula.exe on Windows).
exe option to create a Node.js SEA binary — blob generation, injection, and (on macOS hosts) ad-hoc code signing are handled automaticallyAfter building, run the binary harness. It checks version, help, a JSON-config site build, that TypeScript configs are rejected, download variables, and init:
pnpm test:binaryOr point it at a specific binary:
pnpm test:binary -- ./dist/docula
DOCULA_BINARY=./dist/docula.exe pnpm test:binaryYou can also exercise the binary directly:
# Show help
./dist/docula help
# Show version
./dist/docula version
# Initialize a new project
./dist/docula init -s ./my-site
# Build a site
./dist/docula build -s ./my-site -o ./my-site/distThe CI workflow (.github/workflows/build-binaries.yaml) builds each platform natively on its own runner. Native builds avoid the cross-compile signing pitfall on Apple Silicon, where unsigned Mach-O binaries are killed on launch.
| Platform | Runner | Artifact |
|---|---|---|
| Linux x64 | ubuntu-latest | docula-linux-x64 |
| macOS ARM64 | macos-latest | docula-macos-arm64 |
| Windows x64 | windows-latest | docula-windows-x64.exe |
Binaries are uploaded as build artifacts on every run. Published GitHub Releases are immutable (assets cannot be added after publishing), so the workflow attaches the binaries while the release is still a draft:
main. The workflow builds the binaries, creates a draft release v<version> for that commit if none exists (with auto-generated notes to replace), and attaches all three binaries to it.release (npm) and deploy-site workflows.Run the workflow by hand (Actions → build-binaries → Run workflow on main) to rebuild and re-attach the binaries for the current version; a run on any other branch only produces artifacts. Pushing a version tag re-checks that its release carries every binary. A release published without them cannot be fixed in place — delete the release and its tag, then run the workflow again.
See Docula in action with these open source projects that use it for their documentation:
Code of Conduct and Contributing guidelines.
We take the security of Docula seriously and have multiple layers of protection in place:
main is automatically scanned for security issues before merging.main.For full details, see SECURITY.md or our Security Guidelines.
MIT © Jared Wray
Estimated unpacked size across 45 packages.
39.1 MB+
Includes dependencies.
^4.0.69
4.0.121
^4.0.66
4.0.118
^2.1.0
2.1.0
^7.3.1
7.3.1
^4.0.53
4.0.105