haplo / reflex Goto Github PK

View Code? Open in Web Editor NEW

1.0 0.0 0.0 7.28 MB

The minimalist Pelican theme.

Home Page: http://haplo.github.io/reflex

License: MIT License

JavaScript 0.68% CSS 86.42% HTML 6.82% Python 1.40% Shell 0.32% Less 3.86% Makefile 0.50%

pelican pelican-theme python static-site-generator

reflex's Introduction

Reflex

A minimalist Pelican theme, forked from Flex.

Differences with Flex

In-repo documentation instead of Github wiki.
Shynet tracking support.

Features

Mobile First
Responsive
Semantic
SEO best practices
Open Graph
Rich Snippets (JSON-LD)
Related Posts (via plugin or AddThis)
Series (via plugin)
Minute read (via plugin)
Multiple code highlight styles
Translation support
Dark mode

Integrations

Plugins Support

Install

If you want to try out multiple themes the best way is to use pelican-themes.

The alternative way is to clone this repository. The master branch should be stable and safe to checkout. Then point your THEME setting in the pelican project to the path of the theme.

Settings

Look at settings documentation for details.

Sites using Reflex

https://blog.fidelramos.net/ (source code)

If you have a site using Reflex feel free to open a PR to add it here.

Contributing

Always open an issue before sending a PR. Discuss the problem/feature that you want to code. After discussing, send a PR with your changes.

See the development documentation.

Thank you to all contributors!

Loïc Penaud

License

MIT (full license)

reflex's People

Contributors

Stargazers

reflex's Issues

Display flags for switching languages

Use flag icons instead of language codes like en or es.
Update screenshot in example site.

Put example site in Github pages

Update example site settings and content
Add TOC to example site
Add figures to example site
Include link to example site in README
Github action to rebuild example site on changes to master

Set up gulp watch

For developing the theme it would be useful to support a gulp watch command so any changes to source files would be compiled and available automatically.

See alexandrevicenzi/Flex#226 for original issue in Flex theme.

Fix styles for figure elements

alexandrevicenzi/Flex#225 added styles for figures, but only for <div class="figure">. I'm using markdown-captions markdown extension to generate figures, and it uses semantic <figure> and <figcaption> elements. It would make sense for the theme to support both cases.

This PR extends the selectors of the existing styles, plus:

Center-align figure captions.
Add an optional style to add a border to figures.

Example of default style (left alignment and no border)

Example with border and center alignment:

This issue was originally created as alexandrevicenzi/Flex#302.

Copy documentation from Flex wiki

Flex has documentation on its wiki but Reflex puts documentation inside the docs directory of the repository.

Review Flex's wiki and copy over all relevant documentation.

Style for toc markdown extension

Markdown has a Table of Contents (toc) extension but their output styles are currently unstyled in this theme.

Example document

Title: Table of Content test

[TOC]

# Header 1
blablabla

#Header 2
blablabla

#Header 3
blablabla

Current style

Proposed style

The "Table of Contents" text is controlled in settings:

TOC configuration

MARKDOWN = {
    'extension_configs': {
        'markdown.extensions.toc': {
            'title': 'Table of Contents'
        },
    },
}

Refer to the markdown toc extension docs for full configuration, but the above works for me.

This issue was originally created in alexandrevicenzi/Flex#300.

Shynet tracking support

Shynet is a simple self-hosted web analytics tool.

Add support for tracking through Shynet to the theme.
Document new integration and settings.