{"id":49105437,"url":"https://github.com/devanshbatham/gloss","last_synced_at":"2026-04-21T01:30:37.825Z","repository":{"id":346118927,"uuid":"1188571944","full_name":"devanshbatham/gloss","owner":"devanshbatham","description":"✨ making markdown rendering great again","archived":false,"fork":false,"pushed_at":"2026-03-22T11:37:21.000Z","size":2191,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-23T00:35:07.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/devanshbatham.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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-03-22T09:19:21.000Z","updated_at":"2026-03-22T21:35:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/devanshbatham/gloss","commit_stats":null,"previous_names":["devanshbatham/gloss"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/devanshbatham/gloss","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devanshbatham%2Fgloss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devanshbatham%2Fgloss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devanshbatham%2Fgloss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devanshbatham%2Fgloss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devanshbatham","download_url":"https://codeload.github.com/devanshbatham/gloss/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devanshbatham%2Fgloss/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32072932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T21:26:33.338Z","status":"ssl_error","status_checked_at":"2026-04-20T21:26:22.081Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2026-04-21T01:30:36.908Z","updated_at":"2026-04-21T01:30:37.816Z","avatar_url":"https://github.com/devanshbatham.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gloss\n\n✨ Convert Markdown files into beautiful, editorial-style HTML pages.\n\n\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-a.jpg)\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-b.jpg)\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-c.jpg)\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-d.jpg)\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-e.jpg)\n\n![](https://raw.githubusercontent.com/devanshbatham/gloss/refs/heads/main/static/demo-f.jpg)\n\n\n\n## Features\n\n- **Editorial aesthetic**: with serif typography, drop caps, and crosshair section accents\n- **8 themes**: Light, Dark, Sepia, Nord, Dracula, Green, Rose, Ocean\n- **Zen mode**: for distraction-free reading\n- **Table of contents**: sidebar with hover previews\n- **Text highlighting**: select text, click the marker to highlight. Persists across refreshes.\n- **GitHub-style alerts**: `\u003e [!NOTE]`, `\u003e [!TIP]`, `\u003e [!IMPORTANT]`, `\u003e [!WARNING]`, `\u003e [!CAUTION]`\n- **Footnotes**: `[^1]` references with auto-numbered backlinks\n- **Syntax highlighting**: via highlight.js\n- **KaTeX**: math rendering\n- **Mermaid**: diagram support\n- **Image lightbox** — click images to zoom\n- **Task lists**: `- [x]` / `- [ ]` rendered as styled checkboxes\n- **Heading anchors**: hover any heading to get a `#` permalink (click to copy)\n- **Reading time**: word count and estimated reading time under the title\n- **In-page search**: press `/` or `s` to search with keyboard navigation\n- **Emoji shortcodes**: `:fire:` → 🔥, `:rocket:` → 🚀, `:check:` → ✅, and ~100 more\n- **Back-to-top button**: floating arrow that appears on scroll\n- **Reading progress bar**: thin accent-colored bar at the top of the page\n- **Default theme flag**: `--theme` to set the initial theme\n- Hover effects on code blocks, tables, and diagrams\n- Smooth theme transitions\n- Fully self-contained single HTML file output\n\n## Install\n\n### Global install (recommended)\n\nInstall `gloss` as a global CLI tool using [uv](https://docs.astral.sh/uv/):\n\n```bash\nuv tool install git+https://github.com/devanshbatham/gloss\n```\n\nOr from a local clone:\n\n```bash\ngit clone https://github.com/devanshbatham/gloss.git\ncd gloss\nuv tool install .\n```\n\nThis puts `gloss` on your PATH (`~/.local/bin/gloss`) so you can use it from anywhere.\n\n### Project-local install\n\n```bash\nuv pip install .\n```\n\n## Usage\n\n```bash\ngloss input.md                        # outputs input.html\ngloss input.md output.html            # custom output path\ngloss input.md --theme dracula        # set default theme\n```\n\nAvailable themes: `light` (default), `dark`, `sepia`, `nord`, `dracula`, `green`, `rose`, `ocean`.\n\n### Standalone (no install)\n\nRun the single file directly:\n\n```bash\npython3 gloss.py input.md [output.html] [--theme THEME]\n```\n\n## Using as a Library\n\nInstall gloss into your project:\n\n```bash\nuv pip install git+https://github.com/devanshbatham/gloss\n```\n\nConvert a markdown string to a self-contained HTML string:\n\n```python\nimport gloss\n\nhtml = gloss.render(\"# Hello World\\n\\nThis is **gloss**.\")\n\n# With a specific default theme\nhtml = gloss.render(\"# Hello World\\n\\nThis is **gloss**.\", theme=\"nord\")\n\n# Write it yourself, serve it, embed it — whatever you need\nwith open(\"output.html\", \"w\") as f:\n    f.write(html)\n```\n\n\nConvert a markdown file to an HTML file and return the HTML:\n\n```python\nimport gloss\n\n# Writes to report.html, returns the HTML string\nhtml = gloss.convert(\"report.md\", \"report.html\")\n\n# output_path is optional — defaults to replacing .md with .html\nhtml = gloss.convert(\"report.md\")  # writes report.html\n\n# With a default theme\nhtml = gloss.convert(\"report.md\", theme=\"ocean\")\n```\n\n## Keyboard Shortcuts\n\n| Key | Action |\n|-----|--------|\n| `/` or `s` | Open search |\n| `Escape` | Close search / lightbox / exit zen mode |\n\n## Try It\n\nThe repo includes `test_all_features.md`, a comprehensive markdown file that exercises all supported features (headings, code blocks, math, mermaid diagrams, tables, images, blockquotes, alerts, footnotes, task lists, emoji, collapsible sections, etc.). Use it to see what gloss produces:\n\n```bash\ngloss test_all_features.md\nopen test_all_features.html\n```\n\nOr via the library:\n\n```python\nimport gloss\n\nhtml = gloss.convert(\"test_all_features.md\")\n```\n\nOr via the standalone single file (no install needed):\n\n```bash\npython3 gloss.py test_all_features.md\nopen test_all_features.html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevanshbatham%2Fgloss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevanshbatham%2Fgloss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevanshbatham%2Fgloss/lists"}