Программа принимает на вход два пути к директориям. Первую директорию назовем входной директорией, а вторую — выходной.
Программа обходит все файлы и поддиректории входной директории и выполняет для них следующее:
- Для каждой поддиректории входной директории содается соответствующая ей поддиректория в выходной директории.
- Каждый файл с расширением
.gmi
из входной директории транслируется в соответствующий.html
файл в выходной директории. Трансляция осуществляется в соответствии с форматом разметки gemtext. - Каждый файл с расширением отличным от
.gmi
из входной директории копируется в соответствующее ему место выходной директории или ее поддиректорий.
Файл с расширением .gmi
содержит в себе текст в упрощенной разметке,
которая называется gemtext.
Поддерживаются следующие возможности разметки:
# Заголовок первого уровня
## Заголовок второго уровня
### Заголовок третьего уровня
* Элемент списка
> Цитата
=> https://some-address.com Ссылка
А также:
``` Преформатированный текст ```
Все элементы разметки могут находиться только в начале строки и не могут встречаться в середине текста. То есть, нельзя написать так:
Какой-то текст => http://some-site.org Какая-то ссылка.
При трансляции gemtext
в html
операторы разметки gemtext заменяются на соответствующие html-теги.
Например,
=> http://some-address.com Ссылка
заменяется на:
<a href="http://some-address.com">Ссылка</a>