Инструкция по созданию сайта с книгами на основе технологий ComText. Подходит для библиотеки или архива статей.
Примеры архивов:
Возможности:
- Разметка книг в формате Comtext.
- Автоматическая генерация сайта из файлов в текстовом формате.
- Автоматический экспорт книг и статей в форматы FB2 и EPUB.
- Сервер не требуется: тексты хранятся в репозитории на GitHub, а сайт публикуется автоматически через GitHub Pages.
- Можно использовать свой домен или стандартный адрес GitHub Pages.
Создайте новый репозиторий и скопируйте в него содержимое этого репозитория.
Структура репозитория:
├── comtext.yml
├── index.md
├── readme.md
├── content
│ ├── book01.md
│ └── book02.md
└── .github
└── workflows
└── deploy-site.yml
В файле comtext.yml укажите желаемое название:
vuepress:
title: "Пример сайта"Если вы хотите привязать собственный домен, отредактируйте файл .github/workflows/deploy-site.yml.
Замените:
url: nullна
url: mysite.netВ настройках DNS вашего домена добавьте запись CNAME:
CNAME my-github.github.io.
Замените my-github на имя вашего аккаунта на GitHub.
Если используется собственный домен (например, mysite.net), укажите в comtext.yml:
vuepress:
title: "Пример сайта"
base: "/"Если используется стандартный адрес GitHub Pages вида https://comtextspace.github.io/test-site/, где test-site — имя репозитория, укажите:
vuepress:
title: "Пример сайта"
base: "/test-site/"В настройках репозитория перейдите в раздел Settings → Pages, выберите ветку gh-pages и сохраните изменения.
Поместите файлы книг в каталог content/ в формате Comtext.
Добавьте пути к книгам в comtext.yml:
books:
- content/book01.md
- content/book02.mdДобавьте ссылки на книги в файл главной страницы index.md:
## Книги
- [Первая книга](book01.md) [[files book01]] [PDF](https://my-link){.file-link}
- [Вторая книга](book02.md) [[files book01]] [PDF](https://my-link){.file-link}
После отправки изменений в репозиторий сайт будет автоматически пересобран и опубликован.