Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

A simple theme for Pelican blog based on Bootstrap 4

License

Notifications You must be signed in to change notification settings

vuquangtrong/simplify-theme

Repository files navigation

Simplify Bootstrap Theme

A simple, clean, contentful Bootstrap 4 theme for Pelican blogger.
You can use this theme to host programming articles, journals, or galeries.

Live Demo

Visit the live blog of the theme creator's blog: https://vuquangtrong.github.io/simplify-theme to see theme in action, which is also has some articles about theme's documents.
Source code is at simplify-theme

Features

  • Responsive layout for mobile and desktop (Bootstrap)
  • Quick Search (Tipue Search and/or Google Search)
  • OpenGraph (Facebook) and Twitter support
  • SEO with contentful metadata, ready for search indexing
  • Table of Content sidebar with highlight
  • Back to Top floating button in long article
  • Related posts, next/previous articles
  • Collapsible lists in tags and categories
  • Social Sharing (AddThis or direct links)
  • Comments on articles (Diqus)
  • Rich Snippets (metadata, json-ld, sitemap, robots.txt)

Install

Download the theme from simplify-theme or from pelican-themes.
You may need to check the included example pelicanconf.py and publishconf.py for more information.

PLUGINS NOTE

Starting with version 4.5, Pelican moved to a new plugin structure utilizing namespace packages that can be easily installed via Pip. Plugins supporting this structure will install under the namespace package pelican.plugins and can be automatically discovered by Pelican. To see a list of Pip-installed namespace plugins that are active in your environment, run:

pelican-plugins

The list of necessary plugins is now in the requirements.txt file, and enabled in PLUGINS variable in pelicanconf.py

Integrations

Plugins Support

Markdown extensions

By default Pelican enables below extensions to process your markdown files:

  • markdown.extensions.extra includes abbr, attr_list, def_list, fenced_code, footnotes, and tables
  • markdown.extensions.codehilite
  • markdown.extensions.meta

Simplify theme has some style configs to work with extra extenstions to render your page better:

  • markdown.extensions.sane_lists
  • markdown.extensions.toc
  • markdown.extensions.nl2br
  • markdown_checklist.extension

Customized styles

The theme also bring to you a clean, simple, but contenful layout.
This Simplify Article will guide you how to write content in markdown and how it will be rendered on your page.

Preview

screenshot

How to contribute

Developing Simplify is my effort in some weekends. You are invited to help develop it further.
Feel free to fork the repository, and submit pull requests.
If you find any issues, or have a suggestion, then please open an issue.

License

Simplify is released under the Creative Commons Attribution 4.0 International license.
All contributors will be listed in Authors page. It maybe imcomplete but it is to honor in all they did.
I would like you to have some words to refer to authors work in your page's footer. Thank you in advanced!

About

A simple theme for Pelican blog based on Bootstrap 4

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published