Pelican: установка и базовая настройка сайта

Pelican — это генератор статических сайтов, реализованный на Python. Он преобразует текстовые файлы, дополненные упрощенной разметкой reStructuredText, AsciiDoc или Markdown в HTML страницы.

Рассмотрим установку Pelican, ориентируясь на работу в ОС Windows.

Перед началом установки

Должен быть:

1. подключен Интернет;
2. установлен Python. Требования к версиям описаны в документации к Pelican. Я использовал Python 3.x.

Для Windows: желательно прописать путь к Python в переменной PATH (Пуск/Компьютер/Свойства системы/Дополнительно/Переменные среды), чтобы не пришлось указывать его всякий раз при вызове Python.

Установка Pelican

С помощью pip устанавливаем Pelican:

pip install pelican

pip — это система управления пакетами Python, которая поставляется вместе с Python.

Создание и настройка сайта

1. Создаем каталог для хранения материалов сайта (d:\mysite).
2. Переходим в этот каталог и запускаем pelican-quickstart

cd /d d:\mysyte
pelican-quickstart

Отвечаем на вопросы программы. Можно соглашаться с настройками, принятыми по умолчанию. Обязательно понадобится записать лишь название будущего сайта и его автора, но их, как и все остальные настройки позже можно будет легко изменить в файле pelicanconf.py.

В рабочем каталоге появятся следующие файлы:

mysite/
├── content/
├── pelicanconf.py       # Настройки сайта
└── publishconf.py       # Настройки для публикации сайта

Теперь можно наполнять сайт материалами.

Создаем первую статью

Для этого необходимо создать текстовый файл с расширением *.md (Markdown) примерно следующего содержания:

Title: Установка и настройка блока на Pelican
Date: 2017-05-10 11:59
Category: web
Tags: pelican
Author: admin
Summary: Пошаговая инструкция по установке блога на Pelican

Моя первая статья для блога на Pelican.

и сохранить этот файл в папке content.

Уточнение: в Pelican публикации делятся на articles и pages.

1. articles — статьи или посты складываются в папку content и должны иметь дату создания (Date).
2. страницы pages — это публикации без календарной привязки. Они складываются в contents/pages.

Минимальный заголовок документа включает в себя:

• Title — заголовок публикации, из которого создается имя страницы (для pages и articles),
• Date — дата создания публикации (обязательна только для articles).

Страница создана, пора генерировать из нее HTML-файл.

Генерация HTML-файлов и просмотр результатов

Создадим два bat-файла.

pelrun.bat — генерирует HTML-файлы, выдает отладочную информацию (--debug) и помещает готовые файлы в папку output проекта:

pelican content --debug --autoreload  --output output --settings pelicanconf.py

pelserver.bat — запускает локальный HTTP сервер:

pushd output
python -m pelican.server
popd

Запустим созданные bat-файлы:

start pelrun.bat
start pelserver.bat

Теперь запустим браузер и просмотрим наш сайт по адресу http://localhost:8000/

Благодаря опции -r в pelrun.bat, как только вы измените содержимое папки content (например, добавите туда новую статью), автоматически запустится генерация HTML-файлов, свежие версии которых будут помещены в output.