Beautiful Website for Your Projects

Features

• No configuration required. Just setup the folder structure with a logo, favicon, and css file.
• Builds a static website that can be hosted anywhere.
• Simple search is provided by default out of the box.
• Support for single page with readme or multiple markdown pages in a docs folder.
• Full TypeScript support with typed configuration and IDE autocompletion.
• For more complex projects easily add a docula.config.ts (TypeScript) or docula.config.mjs (JavaScript) file to customize the build process with lifecycle hooks and DoculaConsole logging.
• Will generate a sitemap.xml, robots.txt, and feed.xml for your site.
• Automatically generates llms.txt and llms-full.txt for LLM-friendly indexing of docs, API reference, and changelog content.
• OpenAPI / Swagger support for auto-generating an interactive API reference page.
• Uses Github release notes and file-based changelog entries to generate a changelog with individual pages, pagination, and preview text.
• Uses Github to show contributors and link to their profiles.
• Light, dark, and system theme modes with a built-in toggle.
• Easy styling customization via variables.css with no template editing required.
• Watch mode with auto-rebuild for local development.

Table of Contents

• Getting Started
• Configuration
• CLI
• Templates
• Partial Templates
• Multiple Pages
• Assets
• Styling
• Custom Scripts
• API Reference
• LLM Files
• Announcements
• Changelog
• GitHub Integration
• GitHub Token
• Helper Utilities
• Header Links
• Caching
• Cookie Auth
• Robots & Sitemap
• Open Source Examples
• Code of Conduct and Contributing
• License - MIT

Open Source Examples

See Docula in action with these open source projects that use it for their documentation:

• Cacheable.org - High-performance caching library for Node.js with layered caching support (Source)
• Keyv.org - Simple key-value storage with support for multiple backends (Source)
• Docula.org - Docula's own documentation site, built with Docula (Source)

Code of Conduct and Contributing

Code of Conduct and Contributing guidelines.

License

MIT © Jared Wray