{"id":47928397,"url":"https://github.com/r4sky0/sphinx-lumina-theme","last_synced_at":"2026-05-01T10:03:02.590Z","repository":{"id":348933889,"uuid":"1200414223","full_name":"r4sky0/sphinx-lumina-theme","owner":"r4sky0","description":"A modern Sphinx documentation theme built with Tailwind CSS and Alpine.js","archived":false,"fork":false,"pushed_at":"2026-04-30T05:50:59.000Z","size":24245,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-30T07:19:39.170Z","etag":null,"topics":["alpinejs","dark-mode","documentation","python","sphinx","sphinx-theme","tailwindcss"],"latest_commit_sha":null,"homepage":"https://r4sky0.github.io/sphinx-lumina-theme/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r4sky0.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing/architecture.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-03T11:38:27.000Z","updated_at":"2026-04-30T05:50:54.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/r4sky0/sphinx-lumina-theme","commit_stats":null,"previous_names":["r4sky0/sphinx-lumina-theme"],"tags_count":51,"template":false,"template_full_name":null,"purl":"pkg:github/r4sky0/sphinx-lumina-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r4sky0%2Fsphinx-lumina-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r4sky0%2Fsphinx-lumina-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r4sky0%2Fsphinx-lumina-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r4sky0%2Fsphinx-lumina-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r4sky0","download_url":"https://codeload.github.com/r4sky0/sphinx-lumina-theme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r4sky0%2Fsphinx-lumina-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32492595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["alpinejs","dark-mode","documentation","python","sphinx","sphinx-theme","tailwindcss"],"created_at":"2026-04-04T07:03:46.522Z","updated_at":"2026-05-01T10:03:02.584Z","avatar_url":"https://github.com/r4sky0.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx Lumina Theme\n\n[![PyPI version](https://img.shields.io/pypi/v/sphinx-lumina-theme?color=%2310b981)](https://pypi.org/project/sphinx-lumina-theme/)\n[![License](https://img.shields.io/github/license/r4sky0/sphinx-lumina-theme)](https://github.com/r4sky0/sphinx-lumina-theme/blob/main/LICENSE)\n[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://r4sky0.github.io/sphinx-lumina-theme/)\n\nA modern Sphinx theme that treats documentation as a first-class product experience. Clean typography, responsive layout, dark mode, and instant search — out of the box.\n\n\u003ca href=\"https://r4sky0.github.io/sphinx-lumina-theme/\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/r4sky0/sphinx-lumina-theme/main/docs/assets/demo.gif\" alt=\"Sphinx Lumina Theme — Quick tour showing light and dark mode, sidebar navigation, content area with code blocks, and table of contents\" width=\"100%\"\u003e\n\u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://r4sky0.github.io/sphinx-lumina-theme/\"\u003e\u003cstrong\u003eDocumentation\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- **Dark mode** — follows system preference with manual toggle, no flash of unstyled content\n- **Instant search** — Pagefind-powered search with keyboard navigation (`⌘K`)\n- **Responsive layout** — mobile-first with collapsible sidebar and sticky table of contents\n- **MyST Markdown** — write docs in Markdown with full Sphinx directive support\n- **Interactive HTTP API** — OpenAPI endpoint docs with live \"Try it out\" panels and curl copy buttons; no Swagger UI needed\n- **Code blocks** — syntax highlighting with one-click copy\n- **Self-hosted fonts** — Source Sans 3 and JetBrains Mono, no external CDN calls\n- **Version switcher** — dropdown to navigate between documentation versions, loaded from a JSON URL\n- **Customizable** — accent colors, navigation links, social links, and more via `conf.py`\n\n## Quick Start\n\nRequires **Python 3.12+** and **Sphinx 8.0+**.\n\n```bash\npip install sphinx-lumina-theme\n```\n\nor with uv:\n\n```bash\nuv add sphinx-lumina-theme\n```\n\nSet the theme in your `conf.py`:\n\n```python\nhtml_theme = \"lumina\"\n```\n\nBuild your docs:\n\n```bash\nuv run sphinx-build docs docs/_build/html\n```\n\nThat's it. For MyST Markdown setup and configuration options, see the [Getting Started](https://r4sky0.github.io/sphinx-lumina-theme/getting-started/) guide.\n\n## Configuration\n\nAll options go in `html_theme_options` in your `conf.py`. Every option has a sensible default — you only need to set what you want to change.\n\n```python\nhtml_theme_options = {\n    \"accent_color\": \"#10b981\",\n    \"dark_mode_default\": \"auto\",       # \"auto\", \"light\", or \"dark\"\n    \"nav_links\": \"Guide=/guide, API=/api\",\n    \"source_repository\": \"https://github.com/you/your-repo\",\n    \"social_links\": \"github=https://github.com/you\",\n    \"api_base_url\": \"https://api.example.com/v1\",  # enables interactive API features\n}\n```\n\nSee the full [Configuration](https://r4sky0.github.io/sphinx-lumina-theme/getting-started/configuration.html) reference for all available options.\n\n## Development\n\n```bash\ngit clone https://github.com/r4sky0/sphinx-lumina-theme.git\ncd sphinx-lumina-theme\npnpm install        # JS dependencies\nuv sync --dev       # Python dependencies\npnpm run build      # Build CSS + JS assets\nuv run pytest       # Run tests\n```\n\n## License\n\n[Apache-2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr4sky0%2Fsphinx-lumina-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr4sky0%2Fsphinx-lumina-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr4sky0%2Fsphinx-lumina-theme/lists"}