Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spookey/slick
A fast, minimalist, responsive theme for Hugo that respects your privacy
https://github.com/spookey/slick
hugo hugo-theme minimalist privacy rss speed
Last synced: 6 days ago
JSON representation
A fast, minimalist, responsive theme for Hugo that respects your privacy
- Host: GitHub
- URL: https://github.com/spookey/slick
- Owner: spookey
- License: mit
- Created: 2018-12-09T14:04:20.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T11:50:47.000Z (about 1 month ago)
- Last Synced: 2024-11-07T10:43:06.885Z (13 days ago)
- Topics: hugo, hugo-theme, minimalist, privacy, rss, speed
- Language: HTML
- Homepage: https://themes.gohugo.io/slick
- Size: 53.6 MB
- Stars: 53
- Watchers: 5
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - spookey/slick - A fast, minimalist, responsive theme for Hugo that respects your privacy (HTML)
README
# Slick
A Hugo theme focused on content, cleanliness, speed, responsiveness and privacy.
> Slick is a fork of [Temple](https://github.com/aos/temple) with many
improvements.
…
> Temple is a fork of [Nofancy](https://github.com/gizak/nofancy) with many
improvements.
## Table of Contents
* [Features](#features)
* [Installation](#installation)
* [Customizing](#customizing)
* [Components](#components)
* [Development](#development)
* [Contributing](#contributing)
* [License](#license)
* [Images](#images)
## Features
The main features of this theme include:
* Supports taxonomies of tags, categories and series with their own pages
* Pagination of content lists
* RSS Feed with complete entries
* [Open Graph](http://ogp.me),
[Schema.org](https://schema.org) and
[Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards.html)
support
* Fully customizable menu entries in the header
* Footer with fully customizable links and RSS
* Customizable favicon (with correct mime type for png files)
and ability to inject own css file
* Relies on chroma for syntax highlighting
* Not even one external request (privacy!) - Everything needed is part of this
theme (Fonts, CSS, JS, ...)
* 404 page with customizable text
## Installation
Just download the theme or clone it into
your ``themes/`` directory:
```sh
cd themes && git clone https://github.com/spookey/slick.git
```
Then reference it in your ``config``:
```toml
theme = "slick"
```
Or when building the site, pass it in to the CLI:
```sh
hugo -t slick
```
To setup the 404 page please read the
[instructions](https://gohugo.io/templates/404/#automatic-loading).
## Customizing
Your ``config`` file will hold all your options.
Please have a look into the subfolders of ``_sites`` for working examples.
It is highly recommended to make some adjustments to the ``main``
and the ``footer`` menu (e.g. to link to your **About** page).
## Components
* [PureCSS](https://purecss.io/)
* [Source Code Pro](https://fonts.adobe.com/fonts/source-code-pro)
* [Source Sans Pro](https://fonts.adobe.com/fonts/source-sans-pro)
* [Source Serif Pro](https://fonts.adobe.com/fonts/source-serif-pro)
* [Tomorrow Theme](https://github.com/chriskempson/tomorrow-theme)
as color scheme (Tomorrow Night for syntax highlighting)
**Please Note**:
Files inside the [static] folder are only updated on tagged commits (releases).
## Development
This theme uses
[rollup.js](https://rollupjs.org) and [postCSS](https://postcss.org)
to bundle all files together.
JavaScript is compiled from [TypeScript](http://www.typescriptlang.org).
[Components](#components) are drawn in by [npm](https://www.npmjs.com).
Please have a look inside [package.json] for commands and tools required
for building.
Use ``npm version`` to tag a commit.
## Contributing
Contributions are welcome.
### Features/Enhancements
If you are adding a feature, fork the repository, create a new branch
for your feature and submit a PR.
Please make sure to put documentation for your new feature:
* Place a comment about what your feature is doing above the code.
* If making additions that will affect the ``config`` file, make sure
you update the [config.toml] and [config.yaml] below the ``_sites`` folder
as well as the [CHANGELOG.md].
### Issues/Bugs
Submit a new issue with information about your issue and/or bug. If you
have a solution, then submit a new PR with the guidelines posted above in the
**features** section and link your issue to it using the keyword
"[*closes*](https://help.github.com/articles/closing-issues-using-keywords/)".
## License
Licensed under the MIT License. See the [LICENSE].
## Images
### Screenshot
### Thumbnail
[CHANGELOG.md]: https://github.com/spookey/slick/blob/main/CHANGELOG.md
[config.toml]: https://github.com/spookey/slick/blob/main/_sites/example/config.toml
[config.yaml]: https://github.com/spookey/slick/blob/main/_sites/changelog/config.yaml
[LICENSE]: https://github.com/spookey/slick/blob/main/LICENSE
[package.json]: https://github.com/spookey/slick/blob/main/package.json
[static]: https://github.com/spookey/slick/blob/main/static