{"id":51407712,"url":"https://github.com/jlevy/kpress","last_synced_at":"2026-07-04T12:01:56.192Z","repository":{"id":363919856,"uuid":"1264712365","full_name":"jlevy/kpress","owner":"jlevy","description":"Beautiful, readable web pages from Markdown","archived":false,"fork":false,"pushed_at":"2026-06-10T22:15:29.000Z","size":1307,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-11T00:10:07.615Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlevy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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":"NOTICE.md","maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-06-10T05:49:57.000Z","updated_at":"2026-06-10T19:54:10.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jlevy/kpress","commit_stats":null,"previous_names":["jlevy/kpress"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jlevy/kpress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlevy%2Fkpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlevy%2Fkpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlevy%2Fkpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlevy%2Fkpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlevy","download_url":"https://codeload.github.com/jlevy/kpress/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlevy%2Fkpress/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35120682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-04T02:00:05.987Z","response_time":113,"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":[],"created_at":"2026-07-04T12:01:55.322Z","updated_at":"2026-07-04T12:01:56.182Z","avatar_url":"https://github.com/jlevy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KPress\n\nKPress renders Markdown into polished, readable HTML documents and publishes them as\nstatic sites. It is a Python library and CLI, not a framework: it owns document\nrendering, typography, and the static build pipeline, and stays out of site semantics\nand deployment so publishing pipelines and embedding hosts can wrap it.\n\nWhat you get out of the box:\n\n- High-quality document typography: vendored PT Serif and Source Sans 3, a documented\n  CSS token system, light/dark/system themes with a no-flash bootstrap, print CSS.\n- Reader features as progressive enhancement: table of contents, footnote and link\n  tooltips, code copy, tabs, video popovers, responsive tables, KaTeX math with a MathML\n  no-JS fallback. All JS is native ESM, source-first, zero-build.\n- A full static build: route planning, sitemap/robots/redirects, content-hashed or fully\n  offline (sealed) assets, optional minification and precompression, and a deterministic\n  build manifest.\n- A dynamic host API for embedding applications, and sanitization trust modes for raw\n  HTML.\n\n## Quickstart\n\n```bash\nuv add kpress          # library\nuvx kpress --help      # CLI\n\nmkdir mysite \u0026\u0026 cd mysite\nuvx kpress init        # writes a starter kpress.yml\necho \"# Hello\" \u003e index.md\nuvx kpress build       # renders to public/\n```\n\nKPress is also usable as a library: `kpress.format.render_page(...)` renders one\ndocument, and `kpress.publish.build_site(\"kpress.yml\")` is the programmatic\n`kpress build`. The two runnable examples in [examples/](examples/README.md) show both\nconsumption styles end to end: KPress as the whole static-site generator, and KPress as\nan inner rendering library wrapped by your own site shell.\n\n## Documentation\n\nArchitecture and contracts:\n\n- [kpress-design.md](kpress-design.md): architecture, package boundary, and the public\n  contract (HTML/CSS contracts, asset model, optimizer, host integration).\n- [kpress-reader-features.md](kpress-reader-features.md): the durable catalog of reader\n  features and the behavior each guarantees.\n- [kpress-icons.md](kpress-icons.md): the icon sprite contract.\n\nUsing and validating KPress:\n\n- [examples/](examples/README.md): runnable static-site and wrapper examples.\n- [docs/kpress-static-publish.runbook.md](docs/kpress-static-publish.runbook.md): how to\n  build and ship a static site, and where KPress’s responsibility ends.\n- [docs/kpress-validation.runbook.md](docs/kpress-validation.runbook.md): end-to-end\n  validation gates.\n- [docs/kpress-e2e-testing.runbook.md](docs/kpress-e2e-testing.runbook.md): manual\n  browser acceptance checks.\n\nProject status and process:\n\n- [TODO.md](TODO.md): implementation status ledger.\n- [docs/kpress-completion-plan.md](docs/kpress-completion-plan.md): map of remaining\n  work to verified completion.\n- [CONTRIBUTING.md](CONTRIBUTING.md) and [docs/development.md](docs/development.md): dev\n  setup and the quality gate.\n- [SECURITY.md](SECURITY.md), [SUPPLY-CHAIN-SECURITY.md](SUPPLY-CHAIN-SECURITY.md),\n  [NOTICE.md](NOTICE.md): security policy, dependency policy, and third-party notices.\n\n## Compatibility policy\n\nKPress is a young package and evolves by **hard cuts**: API and contract changes land\ndirectly, with no deprecation shims and no backward-compatibility layers.\nA change is acceptable when an out-of-date caller fails loudly with a clear error\nmessage — never silently.\nThe supported surface is pinned in `kpress.contract` (`PUBLIC_*` names) and enforced by\ntests; changing a public name means updating the contract, docs, tests, and goldens in\nthe same patch, and release/PR notes are the migration guide.\n\n## Development\n\n```bash\nuv sync --all-extras\nuv run pytest tests --tb=short -q\nuv run python devtools/lint.py --check\n```\n\n## License\n\nAGPL-3.0-or-later; see `LICENSE`. Third-party vendored components (Lucide icons, KaTeX,\nPT Serif, Source Sans 3) are listed with their licenses in [NOTICE.md](NOTICE.md).\n\n\u003c!-- This document follows common-doc-guidelines.md.\nSee github.com/jlevy/practical-prose and review guidelines before editing.\n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlevy%2Fkpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlevy%2Fkpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlevy%2Fkpress/lists"}