{"id":13507027,"url":"https://github.com/nairobilug/pelican-alchemy","last_synced_at":"2025-03-30T07:31:51.060Z","repository":{"id":12088462,"uuid":"14676445","full_name":"nairobilug/pelican-alchemy","owner":"nairobilug","description":"A ✨ functional, clean, responsive Pelican theme","archived":false,"fork":false,"pushed_at":"2023-04-17T17:01:37.000Z","size":6392,"stargazers_count":140,"open_issues_count":7,"forks_count":79,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-05-21T08:09:33.618Z","etag":null,"topics":["bootstrap","jinja2","pelican","pelican-theme","static-site-generator"],"latest_commit_sha":null,"homepage":"https://nairobilug.github.io/pelican-alchemy/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nairobilug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2013-11-25T04:48:18.000Z","updated_at":"2024-03-05T19:10:13.000Z","dependencies_parsed_at":"2024-01-21T14:46:00.057Z","dependency_job_id":"1ee55053-cdff-469b-8b66-4a1d2bd515ca","html_url":"https://github.com/nairobilug/pelican-alchemy","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nairobilug%2Fpelican-alchemy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nairobilug%2Fpelican-alchemy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nairobilug%2Fpelican-alchemy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nairobilug%2Fpelican-alchemy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nairobilug","download_url":"https://codeload.github.com/nairobilug/pelican-alchemy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246290551,"owners_count":20753724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","jinja2","pelican","pelican-theme","static-site-generator"],"created_at":"2024-08-01T02:00:19.909Z","updated_at":"2025-03-30T07:31:50.578Z","avatar_url":"https://github.com/nairobilug.png","language":"HTML","funding_links":[],"categories":["Themes","HTML"],"sub_categories":[],"readme":"# Pelican Alchemy\n\n\u003e A magical ✨ Pelican theme\n\nAlchemy is a functional, clean, responsive theme for the [Pelican](http://getpelican.com) static site generator.\n\nInspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog), it features:\n\n- Powered by [Bootstrap 4](https://getbootstrap.com/) (v4.3.1)\n- Supports any [Boostwatch](https://bootswatch.com/) themes\n- [Font Awesome](http://fontawesome.io/) icons\n- [Pygments](http://pygments.org/) syntax highlighting styles\n- Pelican `sitemap.xml` support\n- [Favicon Generator](http://realfavicongenerator.net/) support\n- External analytics ([Google](https://analytics.google.com), [Gauges](https://gaug.es), [Piwik](https://piwik.org)) support **\n- External comments ([Disqus](https://disqus.com)) support **\n\n** Features link to external assets (webfonts etc).\n\n## Screenshots\n\n\u003ctable\u003e\n\u003ctr\u003e\n  \u003ctd colspan=\"2\"\u003e\n    \u003ca href=\"screenshots/default.png\"\u003e\n      \u003cimg src=\"screenshots/default.png\"/\u003e\n      \u003cp align=\"center\"\u003eDefault colors\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\n    \u003ca href=\"screenshots/oldstyle.png\"\u003e\n      \u003cimg src=\"screenshots/oldstyle.png\"/\u003e\n      \u003cp align=\"center\"\u003eOld style (see below)\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"screenshots/sketchy.png\"\u003e\n      \u003cimg src=\"screenshots/sketchy.png\"/\u003e\n      \u003cp align=\"center\"\u003eSketchy (Boostwatch)\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n  \u003ctd\u003e\n    \u003ca href=\"screenshots/solar.png\"\u003e\n      \u003cimg src=\"screenshots/solar.png\"/\u003e\n      \u003cp align=\"center\"\u003eSolar (Boostwatch)\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n  \u003ctd\u003e\n    \u003ca href=\"screenshots/united.png\"\u003e\n      \u003cimg src=\"screenshots/united.png\"/\u003e\n      \u003cp align=\"center\"\u003eUnited (Boostwatch)\u003c/p\u003e\n    \u003c/a\u003e\n  \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003e To enable old visual style add `THEME_CSS_OVERRIDES = ['theme/css/oldstyle.css']`\n\u003e to your `pelicanconf.py` and use no Boostwatch themes.\n\u003e See [stylesheet](alchemy/static/css/oldstyle.css) for more information.\n\n## Installation\n\n### From Git repo\n\nClone the repo:\n\n```bash\ngit clone https://github.com/nairobilug/pelican-alchemy\n```\n\nSet the `THEME` variable in your Pelican config:\n\n```python\nTHEME = '\u003cPATH_TO_REPO\u003e/alchemy'\n```\n\n### As a Submodule\n\nIn your Pelican site:\n\n```bash\nmkdir themes\ngit submodule add https://github.com/nairobilug/pelican-alchemy themes/pelican-alchemy\n```\n\nAnd in Pelican config:\n\n```python\nTHEME = 'themes/pelican-alchemy/alchemy'\n```\n\n### With pip\n\nAlternatively, you can install this theme with pip:\n\n```bash\npip install \"https://github.com/nairobilug/pelican-alchemy/tarball/master\"\n```\n\nAnd import it from Pelican config:\n\n```python\nimport alchemy\nTHEME = alchemy.path()\n```\n\n## Usage\n\nVisit the [Settings docs](docs/settings.md) for examples:\n\n- **SITESUBTITLE**: Subtitle that appears in the header.\n- **SITEIMAGE**: Image that appears in the header.\n- **DESCRIPTION**: Index HTML head `\u003cmeta\u003e` description.\n- **LINKS**: A list of tuples (Title, URL) for menu links.\n- **ICONS**: A list of tuples (Icon, URL) for icon links. Icons are assumed to\n  be Font Awesome brand icons, if you need to use icons from other Font\n  Awesome icon set please provide full [CSS class], e.g. `fas fa-camera`\n  instead on just `camera`\n- **FOOTER_LINKS**: A list of tuples (Title, URL) for footer links. Replaces\n  default set of links (Authors, Archives, Categories, Tags).\n- **BOOTSTRAP_CSS**: URL of Bootstrap CSS file. Use this to enable Boostwatch themes.\n- **FONTAWESOME_CSS**: URL of Font Awesome CSS file. Use this if you wish to\n  use CDN provided version instead of the bundled one.\n- **PYGMENTS_STYLE**: Built-in Pygments style for syntax highlighting.\n- **HIDE_AUTHORS**: Hide the author(s) of an article - useful for single author sites.\n- **RFG_FAVICONS**: Use a Favicon Generator package.\n- **THEME_CSS_OVERRIDES**: Sequence of stylesheet URLs to override CSS provided by theme.\n  Both relative and absolute URLs are supported.\n- **THEME_JS_OVERRIDES**: Sequence of JavaScript URLs to enable with this\n  theme. Alchemy uses no JS by default. Both relative and absolute URLs are\n  supported.\n\n[CSS class]: https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use\n\nMisc settings:\n\n- **DISQUS_SITENAME**\n- **GAUGES**\n- **GOOGLE_ANALYTICS**\n- **PIWIK_URL**\n- **PIWIK_SITE_ID**\n\nExample [pelicanconf.py](https://github.com/nairobilug/pelican-alchemy/blob/demo/pelicanconf.py) (demo website).\n\n### Tips \u0026 Tricks\n\n[See documentation page](docs/pelican-tips.md)\n\n## How to Contribute\n\n1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.\n1. 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).\n1. Send a pull request and bug the maintainer until it gets merged and published. :)\n\nAlchemy follows the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.\n\n## License\n\n[MIT](LICENSE) © 2017 Nairobi GNU/Linux Users Group\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnairobilug%2Fpelican-alchemy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnairobilug%2Fpelican-alchemy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnairobilug%2Fpelican-alchemy/lists"}