Compare commits
21 Commits
c44bf29ac4
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
186e0fd86a
|
|||
|
e76fd935e2
|
|||
|
bf661396df
|
|||
|
3f8b62489c
|
|||
|
ed93e0bf87
|
|||
|
9d85c9556d
|
|||
|
b8a0d145ae
|
|||
|
a2cde12408
|
|||
|
c2f4f4ca9f
|
|||
|
e1e962926e
|
|||
|
828c7dc3b6
|
|||
|
1bd70cb16b
|
|||
|
6e1812c2df
|
|||
|
8d37514d4d
|
|||
|
264f6be0a9
|
|||
|
b27cb687f9
|
|||
|
1a348f8e62
|
|||
|
388f527734
|
|||
|
20f50de0f0
|
|||
|
a5d0f0f6ab
|
|||
|
aadcc8ee6c
|
@@ -1,4 +1,30 @@
|
|||||||
# Pelican LaTeX theme
|
# Pelican LaTeX theme
|
||||||
|
|
||||||
A theme for pelican which mimics the look of LaTeX documents.
|
A theme for [Pelican](https://getpelican.com/) that mimics the look and feel of a LaTeX-typeset document — serif typography (bundled Latin Modern webfonts), justified body text, and syntax-highlighted code blocks styled to match.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Light and dark mode, plus a choice of accent color, all switchable at runtime and remembered across visits
|
||||||
|
- A serif/sans-serif font toggle for readers who prefer either look
|
||||||
|
- Sidebar navigation with pages, recent articles, categories, and a weighted tag cloud
|
||||||
|
- Built-in support for multilingual sites built with Pelican's `i18n_subsites` plugin, including a language switcher and per-page translation links
|
||||||
|
- Lightbox viewer for images, and inline SVG handling that lets diagrams adapt their colors to the current light/dark theme
|
||||||
|
- A small, optional row of social/profile link icons
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
- `templates/` — Jinja2 templates for articles, pages, listing views (archives, tags, categories, authors), and shared partials
|
||||||
|
- `static/css/` — the theme's stylesheet and Pygments syntax-highlighting themes
|
||||||
|
- `static/js/` — the theme/accent/font toggles, lightbox, and SVG handling
|
||||||
|
- `static/fonts/` — the bundled Latin Modern webfonts
|
||||||
|
|
||||||
|
To use the theme, point a Pelican site's `THEME` setting at this repository (or a submodule checkout of it).
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Beyond Pelican's standard settings, the theme reads a few of its own from `pelicanconf.py`:
|
||||||
|
|
||||||
|
- `SOCIAL` — a tuple of `(name, url, icon_slug)` entries for the social/profile link row. `icon_slug` must match an SVG file in `templates/icons/<icon_slug>.svg`; currently bundled are `github`, `linkedin`, `orcid`, `mastodon`, `bluesky`, and `matrix`. Add more by dropping in another icon file with a matching slug. Leave `SOCIAL` unset to omit the row entirely.
|
||||||
|
- `SITE_COMMIT` and `SITE_BRANCH` — optional build identifiers shown as a small line in the footer (e.g. "Build abc1234 (main)"), linked to the commit on Gitea. Meant to be set from a CI environment rather than hand-written; the footer line is omitted if `SITE_COMMIT` is empty.
|
||||||
|
|
||||||
|
The sidebar sections can also be toggled individually, following the same convention as Pelican's default theme: `DISPLAY_PAGES_ON_MENU` and `DISPLAY_CATEGORIES_ON_MENU` (both off unless set to `True`), and `DISPLAY_RECENT_ARTICLES_ON_MENU`/`DISPLAY_TAG_CLOUD_ON_MENU` (both on by default). `RECENT_ARTICLES_COUNT` caps the recent-articles list (default 10).
|
||||||
|
|||||||
Reference in New Issue
Block a user