-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
1,282 additions
and
554 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,127 +1,22 @@ | ||
# /xerographic | ||
# onionskin | ||
|
||
An experimental* theme for the [Hugo](https://gohugo.io/) static site generator. See [heracl.es](https://heracl.es) for a live preview, and the theme’s Git respority [/xerographic](https://github.com/Arty2/xerographic) for more details. | ||
An experimental theme for [Hugo](https://gohugo.io/). | ||
See [heracl.es](https://heracl.es) for a live preview, and [/onionskin](https://heracl.es/onionskin) for more details on the theme. | ||
|
||
* Major breaking changes may occur between versions, both in functionality and design approach. Using versioned releases is more than encouraged. | ||
Not stable, but very usable. Documentation pending. | ||
|
||
## Installation | ||
- Hosted on GitLab: https://gitlab.com/heracles/onionskin | ||
- Mirrored on GitHub: https://github.com/Arty2/onionskin | ||
|
||
The following instructions assume that you already have your site’s content in a Git repository. You may move the provided `.bat` scripts (for Windows 10) in your root directory to easily update to newer versions. | ||
|
||
### As a submodule | ||
|
||
The official [Hugo documentation for themes](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) suggest to install as a *submodule*: | ||
|
||
``` | ||
cd themes | ||
git submodule add https://github.com/Arty2/xerographic | ||
``` | ||
|
||
To update the theme to the most current version: | ||
|
||
``` | ||
cd themes/xerographic | ||
git checkout master | ||
git pull | ||
cd ../../ | ||
``` | ||
|
||
### As a subtree | ||
|
||
Installing as a *subtree* has [several advantages](https://training.github.com/downloads/submodule-vs-subtree-cheat-sheet/) if you wish to actively contribute with pull-requests: | ||
|
||
``` | ||
git remote add xerographic https://github.com/Arty2/xerographic.git | ||
git subtree add --prefix=themes/xerographic xerographic master --squash | ||
``` | ||
|
||
To update the theme to the most current version: | ||
|
||
``` | ||
git subtree pull --prefix=themes/xerographic xerographic master --squash | ||
``` | ||
|
||
## Features | ||
|
||
- Plug & Play; should work with zero configuration. | ||
- Multilingual ready. | ||
- Fully responsive. Two fluid breakpoints. | ||
- Themable. Automatic light and dark themes respective to user settings. | ||
- Sidenotes (marginalia) inspired by [Tufte CSS](https://edwardtufte.github.io/tufte-css/). Collapsible on mobile. | ||
- Inline comments and external links preview when `title=""` is provided. | ||
- Detailed & extensible page and post metadata. Automatic Table of Contents for lengthy posts. | ||
- Page and post types: normal; preformatted. | ||
|
||
## Built-in Shortcodes | ||
|
||
- articles-list | ||
- articles-filter | ||
- gallery | ||
- img | ||
- marginalia | ||
- menu-social | ||
- section | ||
|
||
|
||
## Customisation | ||
|
||
### Favicon | ||
|
||
Add a `/static/favicon.png` file. | ||
|
||
### CSS Variables | ||
|
||
... | ||
|
||
### Custom CSS | ||
|
||
This theme supports per page custom styles via `custom.css` in the page’s bundle or folder. Global styles may be customized by creating a `/static/styles/custom.css` file. | ||
|
||
### Custom JavaScript | ||
|
||
`./script.js` ... | ||
|
||
### Site configuration | ||
|
||
See `config.default.yml` | ||
|
||
```yaml | ||
... | ||
``` | ||
|
||
|
||
## Post and page frontmatter options | ||
|
||
Automatic featured images, by name `*__featured.ext` | ||
|
||
```yaml | ||
title | ||
summary | ||
tags | ||
draft | ||
featured_image | ||
show_comments | ||
show_meta | ||
license | ||
rating | ||
dateread | ||
datecreated | ||
crosspost | ||
publication.title | ||
``` | ||
|
||
|
||
|
||
*** | ||
|
||
## Bundled / Credits | ||
|
||
- jQuery | ||
- [fancybox](http://fancyapps.com/fancybox/3/) | ||
- Alegreya font | ||
- Fantasque Sans Mono font | ||
- fancybox | ||
- leaderline | ||
- Project avatar: [onion by Kyle Tezak](https://thenounproject.com/term/onion/26154) from the Noun Project | ||
|
||
|
||
*** | ||
|
||
© 2018-2020 [Heracles Papatheodorou](http://heracl.es) a.k.a [@Arty2](https://www.twitter.com/Arty2), [MIT Licence](LICENCE.txt) | ||
© 2018-2019 [Heracles Papatheodorou](http://heracl.es) a.k.a [@Arty2](https://www.twitter.com/Arty2), [MIT Licence](LICENCE.txt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.