{"id":17057733,"url":"https://github.com/jieiku/abridge","last_synced_at":"2025-04-12T15:39:58.696Z","repository":{"id":37269211,"uuid":"474813395","full_name":"Jieiku/abridge","owner":"Jieiku","description":"Fast \u0026 Lightweight Zola Theme","archived":false,"fork":false,"pushed_at":"2025-02-03T05:30:23.000Z","size":7062,"stargazers_count":205,"open_issues_count":1,"forks_count":52,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-03T17:11:07.774Z","etag":null,"topics":["accessible","blog","blog-theme","dark-theme","docs-as-code","elasticlunr","katex","local-search","markdown","offline-search","pagefind","pwa","rust","static-site","static-website","theme","tinysearch","website","zola","zola-theme"],"latest_commit_sha":null,"homepage":"https://abridge.pages.dev/","language":"JavaScript","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/Jieiku.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["Jieiku"]}},"created_at":"2022-03-28T02:06:00.000Z","updated_at":"2025-03-19T00:10:45.000Z","dependencies_parsed_at":"2024-01-09T19:45:02.321Z","dependency_job_id":"7c47bf0e-0c76-4059-8393-1240a02e4036","html_url":"https://github.com/Jieiku/abridge","commit_stats":{"total_commits":317,"total_committers":22,"mean_commits":"14.409090909090908","dds":"0.21766561514195581","last_synced_commit":"05a92f2ec6e8c86baafc7d970e8c992d395b9691"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jieiku%2Fabridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jieiku%2Fabridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jieiku%2Fabridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jieiku%2Fabridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jieiku","download_url":"https://codeload.github.com/Jieiku/abridge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248590714,"owners_count":21129877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["accessible","blog","blog-theme","dark-theme","docs-as-code","elasticlunr","katex","local-search","markdown","offline-search","pagefind","pwa","rust","static-site","static-website","theme","tinysearch","website","zola","zola-theme"],"created_at":"2024-10-14T10:27:55.671Z","updated_at":"2025-04-12T15:39:58.683Z","avatar_url":"https://github.com/Jieiku.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Jieiku","https://github.com/sponsors/Jieiku/"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/Jieiku/abridge/master/abridge.svg\"/\u003e\n\n# Abridge Zola Theme\n\nA fast, lightweight, and modern [Zola](https://getzola.org) theme utilizing [abridge.css](https://github.com/Jieiku/abridge.css) (a class-light semantic HTML CSS Framework). Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.pages.dev), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://developer.mozilla.org/en-US/observatory/analyze?host=abridge.netlify.app) scores. Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page.\n\n![Lighthouse Score](https://raw.githubusercontent.com/Jieiku/abridge/master/content/overview-abridge/lighthouse.png)\n\nMaintenance of this project is made possible by all the \u003ca href=\"https://github.com/Jieiku/abridge/graphs/contributors\"\u003econtributors\u003c/a\u003e and \u003ca href=\"https://github.com/sponsors/Jieiku\"\u003esponsors\u003c/a\u003e. If you'd like to sponsor this project and have your avatar or company logo appear below \u003ca href=\"https://github.com/sponsors/Jieiku\"\u003eclick here\u003c/a\u003e. 💖\n\n\u003c!-- sponsors --\u003e\u003ca href=\"https://github.com/yugfletcher\"\u003e\u003cimg src=\"https:\u0026#x2F;\u0026#x2F;github.com\u0026#x2F;yugfletcher.png\" width=\"60px\" alt=\"User avatar: \" /\u003e\u003c/a\u003e\u003ca href=\"https://github.com/samueloph\"\u003e\u003cimg src=\"https:\u0026#x2F;\u0026#x2F;github.com\u0026#x2F;samueloph.png\" width=\"60px\" alt=\"User avatar: Samuel Henrique\" /\u003e\u003c/a\u003e\u003ca href=\"https://github.com/bensuperpc\"\u003e\u003cimg src=\"https:\u0026#x2F;\u0026#x2F;github.com\u0026#x2F;bensuperpc.png\" width=\"60px\" alt=\"User avatar: Bensuperpc\" /\u003e\u003c/a\u003e\u003c!-- sponsors --\u003e\n\n---\n\n**[View Abridge demo](https://abridge.pages.dev/overview-abridge/)**\n\n**[View Abridge.css demo](https://abridge-css.pages.dev/overview-abridge/)** [[abridge.css framework](https://github.com/Jieiku/abridge.css/tree/master/dist)]\n\nThe Abridge.css demo is simply using Abridge theme as a submodule: [config.toml](https://github.com/Jieiku/abridge.css/blob/master/config.toml), [sass/abridge.scss](https://github.com/Jieiku/abridge.css/blob/master/sass/abridge.scss)\n\u003c/div\u003e\n\n## Features\n\n- Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.pages.dev), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://developer.mozilla.org/en-US/observatory/analyze?host=abridge.netlify.app) scores.\n- [PWA support](https://abridge.pages.dev/overview-abridge/#pwa-progressive-web-app) (Progressive Web Application).\n- All JavaScript can be [fully disabled](https://abridge.pages.dev/overview-abridge/#javascript-files).\n- Dark, Light, Auto, and Switcher themes. (colors can be customized, css variables)\n- Code [syntax highlighting](https://abridge.pages.dev/overview-code-blocks/). (colors can be customized, css variables)\n- Numbered code blocks with [line highlighting](https://abridge.pages.dev/overview-code-blocks/#toml).\n- Entirely Offline Site by using the PWA **or** by setting `search_library = \"offline\"` in `config.toml`.\n- Multi-language support.\n- Search support. ([elasticlunr](https://abridge.pages.dev/), [pagefind](https://abridge-pagefind.pages.dev/), [tinysearch](https://abridge-tinysearch.pages.dev/))\n- Search Suggestions navigation keys, `/` focus, `arrow` move, `enter` select, `escape` close.\n- Search Results Page, type search query then hit `Enter Key` or `click` the search button icon.\n- [SEO](https://abridge.pages.dev/overview-abridge/#seo-and-header-tags) support. (Search Engine Optimization)\n- [Pagination](https://abridge.pages.dev/overview-abridge/#pagination) with numbered paginator on index.\n- Title Based Previous and Next Article links at bottom of Article.\n- Table of Contents in page Index (Optional, clickable links)\n- Recent Posts Block. (Optional)\n- Back to Top button. (uses css only)\n- Code Blocks copy button.\n- Email link in footer obfuscation. (anti-spam)\n- [KaTeX](https://katex.org/) support.\n- [Archive page](https://abridge.pages.dev/archive/).\n- [Tags](https://abridge.pages.dev/tags/).\n- Categories. (similar to Tags, disabled/commented out by default)\n- Social icon links in footer.\n- Responsive design. (mobile first)\n- Video Shortcodes: [Youtube](https://abridge.pages.dev/video-streaming-sites/overview-embed-youtube/), [Vimeo](https://abridge.pages.dev/video-streaming-sites/overview-embed-vimeo/), [Streamable](https://abridge.pages.dev/video-streaming-sites/overview-embed-streamable/).\n- Media Shortcodes: [video](https://abridge.pages.dev/overview-rich-content/#video), [img](https://abridge.pages.dev/overview-images/#img-shortcode), [imgswap](https://abridge.pages.dev/overview-images/#imgswap-shortcode), [image](https://abridge.pages.dev/overview-rich-content/#image), [gif](https://abridge.pages.dev/overview-rich-content/#gif), [audio](https://abridge.pages.dev/overview-rich-content/#audio).\n- Other Shortcodes: [showdata](https://abridge.pages.dev/overview-showdata/), [katex](https://abridge.pages.dev/overview-math/#usage-1).\n\n**[Complete Documentation is available here](https://abridge.pages.dev/overview-abridge/)**\n\n## Quick Start\n\nThis theme requires version 0.19.1 or later of [Zola](https://www.getzola.org/documentation/getting-started/installation/)\n\n```bash\ngit clone https://github.com/jieiku/abridge.git\ncd abridge\nzola serve\n# open http://127.0.0.1:1111/ in the browser\n```\n\n## Installation\n\nThe Quick Start shows how to run the theme directly. Next we will use abridge as a theme to a NEW site.\n\n### 1: Create a new zola site\n\n```bash\nyes \"\" | zola init mysite\ncd mysite\n```\n\n### 2: Install Abridge\n\nAdd the theme as a git submodule:\n\n```bash\ngit init  # if your project is a git repository already, ignore this command\ngit submodule add https://github.com/jieiku/abridge.git themes/abridge\ngit submodule update --init --recursive\ngit submodule update --remote --merge\n```\n\nOr clone the theme into your themes directory:\n\n```bash\ngit clone https://github.com/jieiku/abridge.git themes/abridge\n```\n\n### 3: Configuration\n\nCopy some files from the theme directory to your project's root directory:\n\n```bash\nrsync themes/abridge/.gitignore .gitignore\nrsync themes/abridge/config.toml config.toml\nrsync themes/abridge/content/_index.md content/\nrsync -r themes/abridge/COPY-TO-ROOT-SASS/* sass/\nrsync themes/abridge/netlify.toml netlify.toml\nrsync themes/abridge/package_abridge.js package_abridge.js\nrsync themes/abridge/package.json package.json\n```\n\n- `config.toml` base configuration with all config values.\n- `content/_index.md` required to set pagination.\n- `COPY-TO-ROOT-SASS/abridge.scss` overrides to customize Abridge variables.\n- `netlify.toml` settings to deploy your repo with netlfiy.\n- `package_abridge.js` node script to: update cache files list in PWA, minify js, bundle js\n- `package.json` to facilitate use of package_abridge.js\n\nUncomment the theme line in your project's root config.toml:\n\n```bash\nsed -i 's/^#theme = \"abridge\"/theme = \"abridge\"/' config.toml\n```\n\n### 4: Add new content\n\nCopy the content from the theme directory to your project or make a new post:\n\n```bash\nrsync -r themes/abridge/content .\n```\n\n### 5: Run the project\n\nJust run `zola serve` in the root path of the project:\n\n```bash\nzola serve\n```\n\nZola will start the dev web server, accessible by default at `http://127.0.0.1:1111`.\n\nSaved changes will live reload in the browser. (press `ctrl+f5`, or while developing set `pwa=false` in `config.toml`)\n\n## Customization\n\nFor further customization be sure to [check the docs](https://abridge.pages.dev/overview-abridge/).\n\n## Sponsor\n\nDo you love this theme? Was it useful to you? Please leave a github star, and if you feel inclined to donate you can make a donation to me through [github sponsors](https://github.com/sponsors/Jieiku/).\n\n## Contributing and Philosophy\n\nWe'd love your help! Especially with fixes to issues, or improvements to existing features.\n\nThe goal is for Abridge to be lightweight, fast, and to work properly even if javascript is disabled or blocked.\n\nThe only feature that may be considered a necessity that relies on javascript is the Search.\n\n## License\n\n**Abridge** is distributed under the terms of the [MIT license](https://github.com/jieiku/abridge/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjieiku%2Fabridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjieiku%2Fabridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjieiku%2Fabridge/lists"}