haplo / reflex Goto Github PK

Shynet is a simple self-hosted web analytics tool.

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

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.

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.

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.

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.

• 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