mirror of
https://github.com/nairobilug/pelican-alchemy.git
synced 2024-12-30 12:15:06 +01:00
63e4576c4a
This commit adds new configuration parameter, THEME_CSS_OVERRIDES, which can contain a sequence (list, tuple, etc) of URLs to extra stylesheets that will be used to override default theme appearance. Both absolute and relative URLs are supported. It makes the theme more flexible by allowing small stylesheet tweaks without requiring to maintain a fork of the whole theme. When this parameter is not set the theme behaves same as before.
89 lines
2.8 KiB
Markdown
89 lines
2.8 KiB
Markdown
# Pelican Alchemy
|
|
|
|
> A magical ✨ Pelican theme
|
|
|
|
Alchemy is a functional, clean, responsive theme for the [Pelican](http://getpelican.com) static site generator.
|
|
|
|
Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog), it features:
|
|
|
|
- Powered by [Bootstrap 4](https://getbootstrap.com/) (v4.0.0-beta.3)
|
|
- [Font Awesome](http://fontawesome.io/) icons
|
|
- [Pygments](http://pygments.org/) syntax highlighting styles
|
|
- Pelican `sitemap.xml` support
|
|
- [Favicon Generator](http://realfavicongenerator.net/) support
|
|
- External analytics ([Google](https://analytics.google.com), [Gauges](https://gaug.es), [Piwik](https://piwik.org)) support **
|
|
- External comments ([Disqus](https://disqus.com)) support **
|
|
|
|
** Features link to external assets (webfonts etc).
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Clone the repo:
|
|
|
|
```bash
|
|
git clone https://github.com/nairobilug/pelican-alchemy
|
|
```
|
|
|
|
Set the `THEME` variable in your Pelican config:
|
|
|
|
```python
|
|
THEME = '<PATH_TO_REPO>/alchemy'
|
|
```
|
|
|
|
### As a Submodule
|
|
|
|
In your Pelican site:
|
|
|
|
```bash
|
|
mkdir themes
|
|
git submodule add https://github.com/nairobilug/pelican-alchemy themes/pelican-alchemy
|
|
```
|
|
|
|
And in Pelican config:
|
|
|
|
```python
|
|
THEME = 'themes/pelican-alchemy/alchemy'
|
|
```
|
|
|
|
## Usage
|
|
|
|
Visit the [Settings wiki](https://github.com/nairobilug/pelican-alchemy/wiki/Settings) for examples:
|
|
|
|
- **SITESUBTITLE**: Subtitle that appears in the header.
|
|
- **SITEIMAGE**: Image that appears in the header.
|
|
- **DESCRIPTION**: Index HTML head `<meta>` description.
|
|
- **LINKS**: A list of tuples (Title, URL) for menu links.
|
|
- **ICONS**: A list of tuples (Icon, URL) for icon links.
|
|
- **PYGMENTS_STYLE**: Built-in Pygments style for syntax highlighting.
|
|
- **HIDE_AUTHORS**: Hide the author(s) of an article - useful for single author sites.
|
|
- **RFG_FAVICONS**: Use a Favicon Generator package.
|
|
- **THEME_CSS_OVERRIDES**: Sequence of stylesheet URLs to override CSS provided by theme.
|
|
Both relative and absolute URLs are supported.
|
|
|
|
Misc settings:
|
|
|
|
- **DISQUS_SITENAME**
|
|
- **GAUGES**
|
|
- **GOOGLE_ANALYTICS**
|
|
- **PIWIK_URL**
|
|
- **PIWIK_SITE_ID**
|
|
|
|
Example [pelicanconf.py](https://github.com/nairobilug/pelican-alchemy/blob/demo/pelicanconf.py) (demo website).
|
|
|
|
### Tips & Tricks
|
|
|
|
https://github.com/nairobilug/pelican-alchemy/wiki/Tips
|
|
|
|
## How to Contribute
|
|
|
|
1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
|
|
1. Fork [the repository](https://github.com/nairobilug/pelican-alchemy) on GitHub to start making your changes to the master branch (or branch off of it).
|
|
1. Send a pull request and bug the maintainer until it gets merged and published. :)
|
|
|
|
Alchemy follows the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) © 2017 Nairobi GNU/Linux Users Group
|