diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c09383a --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Gemini сервер на OpenResty + +Просто выводит капсулу index.gem, которую можно генерировать уже как угодно. + +Абстрактный каркас для быстрого развертывания текстового сайта (капсулы) в сети протокола Gemini. + +## Как использовать + +1. Скопируйте файлы `.gmi` в корневую директорию вашего Gemini-сервера (root_path в server.lua). +2. Отредактируйте ссылки в формате `=> /путь/к/файлу.gmi` под вашу структуру. +3. Проверьте отображение через любой Gemini-клиент (Lagrange, Amfora, Bombadillo). + +## Особенности формата Gemtext + +* Заголовки размечаются знаками `#`, `##`, `###`. +* Ссылки всегда начинаются с `=> ` и занимают всю строку. +* Списки оформляются через звездочку `* `. +* Блоки кода оборачиваются в три обратных апострофа ` ``` `. |