{"id":15022513,"url":"https://github.com/jaredwray/docula","last_synced_at":"2026-04-01T18:02:43.195Z","repository":{"id":63593512,"uuid":"211403956","full_name":"jaredwray/docula","owner":"jaredwray","description":"Beautiful Website for Your Projects","archived":false,"fork":false,"pushed_at":"2026-03-30T21:56:42.000Z","size":16941,"stargazers_count":12,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-30T22:24:16.480Z","etag":null,"topics":["cli","documentation","documentation-site","markdown","mdx","nodejs","openapi","templates"],"latest_commit_sha":null,"homepage":"https://docula.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaredwray.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2019-09-27T21:24:01.000Z","updated_at":"2026-03-29T09:02:37.000Z","dependencies_parsed_at":"2024-02-26T00:23:30.865Z","dependency_job_id":"98886379-db78-40d9-aaa2-fb0b22d0121d","html_url":"https://github.com/jaredwray/docula","commit_stats":{"total_commits":467,"total_committers":4,"mean_commits":116.75,"dds":0.3854389721627409,"last_synced_commit":"d93f639c2e0e211707e3e9e61e0604ddaf7f6f71"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"purl":"pkg:github/jaredwray/docula","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredwray%2Fdocula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredwray%2Fdocula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredwray%2Fdocula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredwray%2Fdocula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaredwray","download_url":"https://codeload.github.com/jaredwray/docula/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredwray%2Fdocula/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","documentation","documentation-site","markdown","mdx","nodejs","openapi","templates"],"created_at":"2024-09-24T19:58:03.447Z","updated_at":"2026-04-01T18:02:43.187Z","avatar_url":"https://github.com/jaredwray.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Docula](site/logo.svg)\n\n# Beautiful Website for Your Projects\n\n[![tests](https://github.com/jaredwray/docula/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/docula/actions/workflows/tests.yaml)\n[![GitHub license](https://img.shields.io/github/license/jaredwray/docula)](https://github.com/jaredwray/docula/blob/master/LICENSE)\n[![codecov](https://codecov.io/gh/jaredwray/docula/branch/main/graph/badge.svg?token=RS0GPY4V4M)](https://codecov.io/gh/jaredwray/docula)\n[![npm](https://img.shields.io/npm/dm/docula)](https://npmjs.com/package/docula)\n[![npm](https://img.shields.io/npm/v/docula)](https://npmjs.com/package/docula)\n\n# Features\n* No configuration required. Just setup the folder structure with a logo, favicon, and css file.\n* Builds a static website that can be hosted anywhere.\n* Simple search is provided by default out of the box.\n* Support for single page with readme or multiple markdown pages in a docs folder.\n* Full TypeScript support with typed configuration and IDE autocompletion.\n* 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.\n* Will generate a sitemap.xml, robots.txt, and `feed.xml` for your site.\n* Automatically generates `llms.txt` and `llms-full.txt` for LLM-friendly indexing of docs, API reference, and changelog content.\n* OpenAPI / Swagger support for auto-generating an interactive API reference page.\n* Uses Github release notes and file-based changelog entries to generate a changelog with individual pages, pagination, and preview text.\n* Uses Github to show contributors and link to their profiles.\n* Light, dark, and system theme modes with a built-in toggle.\n* Easy styling customization via `variables.css` with no template editing required.\n* Watch mode with auto-rebuild for local development.\n\n# Table of Contents\n- [Getting Started](https://docula.org/docs/index)\n- [Configuration](https://docula.org/docs/configuration)\n- [CLI](https://docula.org/docs/cli)\n- [Templates](https://docula.org/docs/templates)\n- [Partial Templates](https://docula.org/docs/partial-templates)\n- [Multiple Pages](https://docula.org/docs/multiple-pages)\n- [Assets](https://docula.org/docs/assets)\n- [Styling](https://docula.org/docs/styling)\n- [Custom Scripts](https://docula.org/docs/custom-scripts)\n- [API Reference](https://docula.org/docs/api-reference)\n- [LLM Files](https://docula.org/docs/llm-files)\n- [Announcements](https://docula.org/docs/using-announcements)\n- [Changelog](https://docula.org/docs/changelog)\n- [GitHub Integration](https://docula.org/docs/github-integration)\n- [GitHub Token](https://docula.org/docs/github-token)\n- [Helper Utilities](https://docula.org/docs/helper-utilities)\n- [Header Links](https://docula.org/docs/header-links)\n- [Caching](https://docula.org/docs/caching)\n- [Cookie Auth](https://docula.org/docs/cookie-auth)\n- [Robots \u0026 Sitemap](https://docula.org/docs/robots-and-sitemap)\n- [Open Source Examples](#open-source-examples)\n- [Code of Conduct and Contributing](#code-of-conduct-and-contributing)\n- [License - MIT](#license)\n\n# Open Source Examples\n\nSee Docula in action with these open source projects that use it for their documentation:\n\n* **[Cacheable.org](https://cacheable.org)** - High-performance caching library for Node.js with layered caching support ([Source](https://github.com/jaredwray/cacheable))\n* **[Keyv.org](https://keyv.org)** - Simple key-value storage with support for multiple backends ([Source](https://github.com/jaredwray/keyv))\n* **[Docula.org](https://docula.org)** - Docula's own documentation site, built with Docula ([Source](https://github.com/jaredwray/docula))\n\n# Code of Conduct and Contributing\n[Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) guidelines.\n\n# License\nMIT © [Jared Wray](https://jaredwray.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredwray%2Fdocula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaredwray%2Fdocula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredwray%2Fdocula/lists"}