mirror of https://github.com/getzola/zola
183 lines
8.3 KiB
Markdown
183 lines
8.3 KiB
Markdown
|
|
+++
|
|
title = "abridge"
|
|
description = "A fast and lightweight Zola theme using semantic html, a class-light abridge.css, and No mandatory JS."
|
|
template = "theme.html"
|
|
date = 2024-09-02T05:58:27Z
|
|
|
|
[extra]
|
|
created = 2024-09-02T05:58:27Z
|
|
updated = 2024-09-02T05:58:27Z
|
|
repository = "https://github.com/Jieiku/abridge.git"
|
|
homepage = "https://github.com/jieiku/abridge"
|
|
minimum_version = "0.19.1"
|
|
license = "MIT"
|
|
demo = "https://abridge.pages.dev/"
|
|
|
|
[extra.author]
|
|
name = "Jake G (jieiku)"
|
|
homepage = "https://github.com/jieiku/"
|
|
+++
|
|
|
|
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/Jieiku/abridge/master/abridge.svg"/>
|
|
|
|
# Abridge Zola Theme
|
|
|
|
A 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://observatory.mozilla.org/analyze/abridge.pages.dev) scores. Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page.
|
|
|
|
|
|
|
|
Maintenance of this project is made possible by all the <a href="https://github.com/Jieiku/abridge/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/Jieiku">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/Jieiku">click here</a>. 💖
|
|
|
|
<!-- sponsors --><a href="https://github.com/yugfletcher"><img src="https://github.com/yugfletcher.png" width="60px" alt="" /></a><a href="https://github.com/samueloph"><img src="https://github.com/samueloph.png" width="60px" alt="Samuel Henrique" /></a><!-- sponsors -->
|
|
|
|
---
|
|
|
|
**[View Abridge demo](https://abridge.pages.dev/overview-abridge/)**
|
|
|
|
**[View Abridge.css demo](https://abridge-css.pages.dev/overview-abridge/)** [[abridge.css framework](https://github.com/Jieiku/abridge.css/tree/master/dist)]
|
|
|
|
The 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)
|
|
</div>
|
|
|
|
## Features
|
|
|
|
- Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.pages.dev), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.pages.dev) scores.
|
|
- [PWA support](https://abridge.pages.dev/overview-abridge/#pwa-progressive-web-app) (Progressive Web Application).
|
|
- All JavaScript can be [fully disabled](https://abridge.pages.dev/overview-abridge/#javascript-files).
|
|
- Dark, Light, Auto, and Switcher themes. (colors can be customized, css variables)
|
|
- Code [syntax highlighting](https://abridge.pages.dev/overview-code-blocks/). (colors can be customized, css variables)
|
|
- Numbered code blocks with [line highlighting](https://abridge.pages.dev/overview-code-blocks/#toml).
|
|
- Entirely Offline Site by using the PWA **or** by setting `offline = true` in `config.toml` (full search support).
|
|
- Multi-language support.
|
|
- Search support. ([elasticlunr](https://abridge.pages.dev/), [pagefind](https://abridge-pagefind.pages.dev/), [tinysearch](https://abridge-tinysearch.pages.dev/))
|
|
- Search Suggestions navigation keys, `/` focus, `arrow` move, `enter` select, `escape` close.
|
|
- Search Results Page, type search query then hit `Enter Key` or `click` the search button icon.
|
|
- [SEO](https://abridge.pages.dev/overview-abridge/#seo-and-header-tags) support. (Search Engine Optimization)
|
|
- [Pagination](https://abridge.pages.dev/overview-abridge/#pagination) with numbered paginator on index.
|
|
- Title Based Previous and Next Article links at bottom of Article.
|
|
- Table of Contents in page Index (Optional, clickable links)
|
|
- Recent Posts Block. (Optional)
|
|
- Back to Top button. (uses css only)
|
|
- Code Blocks copy button.
|
|
- Email link in footer obfuscation. (anti-spam)
|
|
- [KaTeX](https://katex.org/) support.
|
|
- [Archive page](https://abridge.pages.dev/archive/).
|
|
- [Tags](https://abridge.pages.dev/tags/).
|
|
- Categories. (similar to Tags, disabled/commented out by default)
|
|
- Social icon links in footer.
|
|
- Responsive design. (mobile first)
|
|
- 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/).
|
|
- 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).
|
|
- Other Shortcodes: [showdata](https://abridge.pages.dev/overview-showdata/), [katex](https://abridge.pages.dev/overview-math/#usage-1).
|
|
|
|
**[Complete Documentation is available here](https://abridge.pages.dev/overview-abridge/)**
|
|
|
|
## Quick Start
|
|
|
|
This theme requires version 0.19.1 or later of [Zola](https://www.getzola.org/documentation/getting-started/installation/)
|
|
|
|
```bash
|
|
git clone https://github.com/jieiku/abridge.git
|
|
cd abridge
|
|
zola serve
|
|
# open http://127.0.0.1:1111/ in the browser
|
|
```
|
|
|
|
## Installation
|
|
|
|
The Quick Start shows how to run the theme directly. Next we will use abridge as a theme to a NEW site.
|
|
|
|
### 1: Create a new zola site
|
|
|
|
```bash
|
|
yes "" | zola init mysite
|
|
cd mysite
|
|
```
|
|
|
|
### 2: Install Abridge
|
|
|
|
Add the theme as a git submodule:
|
|
|
|
```bash
|
|
git init # if your project is a git repository already, ignore this command
|
|
git submodule add https://github.com/jieiku/abridge.git themes/abridge
|
|
git submodule update --init --recursive
|
|
git submodule update --remote --merge
|
|
```
|
|
|
|
Or clone the theme into your themes directory:
|
|
|
|
```bash
|
|
git clone https://github.com/jieiku/abridge.git themes/abridge
|
|
```
|
|
|
|
### 3: Configuration
|
|
|
|
Copy some files from the theme directory to your project's root directory:
|
|
|
|
```bash
|
|
rsync themes/abridge/.gitignore .gitignore
|
|
rsync themes/abridge/config.toml config.toml
|
|
rsync themes/abridge/content/_index.md content/
|
|
rsync -r themes/abridge/COPY-TO-ROOT-SASS/* sass/
|
|
rsync themes/abridge/netlify.toml netlify.toml
|
|
rsync themes/abridge/package_abridge.js package_abridge.js
|
|
rsync themes/abridge/package.json package.json
|
|
```
|
|
|
|
- `config.toml` base configuration with all config values.
|
|
- `content/_index.md` required to set pagination.
|
|
- `COPY-TO-ROOT-SASS/abridge.scss` overrides to customize Abridge variables.
|
|
- `netlify.toml` settings to deploy your repo with netlfiy.
|
|
- `package_abridge.js` node script to: update cache files list in PWA, minify js, bundle js
|
|
- `package.json` to facilitate use of package_abridge.js
|
|
|
|
Uncomment the theme line in your project's root config.toml:
|
|
|
|
```bash
|
|
sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml
|
|
```
|
|
|
|
### 4: Add new content
|
|
|
|
Copy the content from the theme directory to your project or make a new post:
|
|
|
|
```bash
|
|
rsync -r themes/abridge/content .
|
|
```
|
|
|
|
### 5: Run the project
|
|
|
|
Just run `zola serve` in the root path of the project:
|
|
|
|
```bash
|
|
zola serve
|
|
```
|
|
|
|
Zola will start the dev web server, accessible by default at `http://127.0.0.1:1111`.
|
|
|
|
Saved changes will live reload in the browser. (press `ctrl+f5`, or while developing set `pwa=false` in `config.toml`)
|
|
|
|
## Customization
|
|
|
|
For further customization be sure to [check the docs](https://abridge.pages.dev/overview-abridge/).
|
|
|
|
## Sponsor
|
|
|
|
Do 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/).
|
|
|
|
## Contributing and Philosophy
|
|
|
|
We'd love your help! Especially with fixes to issues, or improvements to existing features.
|
|
|
|
The goal is for Abridge to be lightweight, fast, and to work properly even if javascript is disabled or blocked.
|
|
|
|
The only feature that may be considered a necessity that relies on javascript is the Search.
|
|
|
|
## License
|
|
|
|
**Abridge** is distributed under the terms of the [MIT license](https://github.com/jieiku/abridge/blob/master/LICENSE).
|
|
|
|
|