1
0
Fork 0
forked from github/pelican
pelican-theme/README.md

43 lines
1.1 KiB
Markdown
Raw Normal View History

2024-10-21 07:53:36 +02:00
# lugh Pelican theme
This theme is based on the [simple theme](https://github.com/getpelican/pelican/tree/main/pelican/themes/simple/templates).
It's heavily customized to what I need here, so no efforts have been made to
keep it useful for others. Amongst other things, I:
- removed translations
- changed the structure (HTML `<footer>` etc.)
2024-10-21 07:53:36 +02:00
## Docs
- [Pelican: how to create your own theme](https://docs.getpelican.com/en/stable/themes.html)
- [Tailwind CSS quick start](https://tailwindcss.com/docs/installation)
## Doing
2024-10-21 07:53:36 +02:00
### Prepare Pelican development server config
2024-10-21 07:53:36 +02:00
Adapt Pelican's `publishconf.py` for local development.
E.g. `RELATIVE_URLS = False`
2024-10-21 07:53:36 +02:00
### Install Tailwind CSS Typography plugin
2024-10-21 07:53:36 +02:00
Typography enables sane defaults for longer texts. In this case, we use it for
the body content only, which is always Markdown. Typography is a bit of a beast
to configure/align to standard Tailwind.
```shell
npm install -D @tailwindcss/typography
```
### Run the Tailwind build process
```shell
npx tailwindcss -i static/css/in.css -o static/css/out.css --watch
```
### Run Pelican dev server
2024-10-21 07:53:36 +02:00
```shell
conda activate pelican
./devserver.sh
```