mirror of
https://github.com/nairobilug/pelican-alchemy.git
synced 2024-12-30 12:15:06 +01:00
18996a6c1d
Alchemy is a great theme, but it was not using the full potential of underlying technology. Bootstrap provides an easy way to customize look and feel of rendered pages, and a lot of themes for Bootstrap are freely available, e.g. at <https://boostwatch.com> This commit introduces a new configuration variable BOOTSTRAP_CSS to make use of any existing Bootstrap skins. All incompatibilities in `theme.css` were fixed: - Instead of using constant color values we use Bootstrap css variables for colors: <https://getbootstrap.com/docs/4.3/getting-started/theming/#css-variables> - The only hardcoded color value left is the color for header/footer borders. It was moved into a variable `--alchemy-border` for easier overriding if needed. I have tested the current value against both dark and light Boostwatch themes, it works ok. - Pagination template was slightly changed to avoid producing invisible text with some of Bootstrap skins
88 lines
2.7 KiB
Markdown
88 lines
2.7 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.
|
|
- **BOOTSTRAP_CSS**: URL of Bootstrap CSS file. Use this to enable Boostwatch themes.
|
|
- **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.
|
|
|
|
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
|