Files
dedinit.ru/content/posts/20190310 quickstart pelican/index.md
T

64 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
+++
title = "Быстрый старт работы с Pelican"
date = "2019-03-10"
description = "описание как быстро настроить и запустить статический генератор сайтов Pelican"
tags = [ "blog", "linux",
]
cover = { image = "hero.svg" }
+++
# Быстрый старт
Настоятельно рекомендуем прочитать полную версию документации, но для особо нетерпеливых ниже представлен ряд шагов, чтобы быстро начать работу.
# Подготовка
В системе GNU/Linux Debian Buster по-умолчанию уже устанолен Python 3.7 Установим утилиту для создния виртуального окружения venv.
`$ sudo aptitude install python3-venv`
Он включает в свой состав утилиты pip для установки пакетов
Создаем каталог в котором будет работать Pelican:
`$ mkdir pelican && cd pelican`.
Создаем внутри каталога виртуальную среду Pytnon `$ python3 -m venv pelicanenv` и активируем её командой `$ source pelicanenv/bin/activate`
# Установка
Устанавливаем Pelican (и дополнительно Markdown) на Python 3.7+, выполнив следующую команду в терминале:
`(pelicanenv) $ pip install pelican[Markdown]`
# Создание проекта
Выбираем имя для проекта и создаем каталог с соответствующим именем для сайта и переходим в этот каталог:
`(pelicanenv) $ mkdir -p ./projects/yoursite.ru
(pelicanenv) $ cd ./projects/yoursite.ru`
Дальше создаем основу для проекта с помощью команды `pelican-quickstart`. Эта команда задаст несколько вопросов о создаваемом сайте. На вопрос о URL адресе сайта следует ответить в том же виде как будет отображено в примере http://yoursite.ru
# Создаем статью
Для того чтобы запустить Pelican потребуется создать хотя бы одну статью. Для этого в любом тектосовм редакторе создаем файл со следующим cодержимым:
`Title: Мой Первый Отзыв
Date: 2020-05-04 10:20
Category: Обзор
Ниже приведен обзор моей любимой механической клавиатуры.`
Поскольку эта статья для примера рассматривает работу с данными в формате Markdown, то сохранить его нужно как `./projects/yoursite.ru/content/keyboard-review.md`.
# Генерируем сайт
В корневом каталоге проекта `./projects/yoursite.ru/`выполните pelican-команду для создания сайта:
`(pelicanenv) $ pelican content`
В результате выполенния команды сайт был создан внутри каталога `./projects/yoursite.ru/output`. В процесе работы могут отобразиться предупреждения, относящееся к RSS лентам, но это нормально при локальном развертывании и можно пока не обращать на них внимание.
# Предварительный просмотр сайта
Открываем сеанс терминала, перейдим в корневой каталог проекта `./projects/yoursite.ru/`и выполняем команду для запуска веб-сервера Pelican:
`(pelicanenv) pelican --listen`
Теперь просмотреть сгенерированный сайт можно перейдя на http://localhost:8000/ в браузере.
Более подробная информация содержится вдокументации, продолжайте изучать её. Так же на странице [Tutorials](https://github.com/getpelican/pelican/wiki/Tutorials) wiki Pelican приведены ссылки на опубликованные сообществом руководства.
# Источники
https://python-scripts.com/virtualenv
https://docs.getpelican.com/en/stable/quickstart.html