1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/caixw-blogit

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
USAGE.md 7.6 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 15:48 e8bb47b

Использование

Данный документ описывает конфигурацию для blogit:

Инициализация

Инициализацию можно провести с помощью команды blogit init path/to/blog/dir, которая создаст полный проектный файл в каталоге path/to/blog/dir.

conf.yaml

conf.yaml — это файл конфигурации проекта, который отвечает за большинство глобальных изменений в проекте.

Наименование Тип Описание
title string Сайт
subtitle string Подзаголовок сайта
titleSeparator string Разделитель заголовков в теге html>head>title. Для неглавной страницы используется для добавления названия сайта после заголовка
url string Корневой каталог сайта, например https://example.com/blog
language string Язык сайта по умолчанию, используемый в статьях без специального указания. Например, cmn-Hans
uptime string Время запуска сайта в формате RFC3999
icon Icon Определение значка favicon
author Author Автор сайта
license Link Информация о лицензии сайта
theme string Тема сайта. Название должно соответствовать имени папки themes/
keywords string Значение тега html>head>meta.keywords на главной странице
description string Значение тега html>head>meta.description на главной странице
menus []Link Содержание меню
toc number Количество заголовков, при превышении которого будет создан TOC. По умолчанию 0
index Index Настройки индексной страницы
archive Archive Определения страницы архива. Может быть пустым, если страница не нужна
rss RSS Определения RSS. Может быть пустым, если RSS не нужен
atom RSS Определения Atom. Может быть пустым, если Atom не нужен
Sitemap Sitemap Определения файла Sitemap. Может быть пустым, если Sitemap не нужен
Robots []Agent Конфигурация robots.txt. Если пусто, то файл robots.txt не создаётся и управление им осуществляется через проект
Profile Profile Управление созданием README.md. В профиле GitHub отображается только для проектов с тем же именем, что и у учётной записи

Icon

Наименование Тип Описание
url string Адрес значка, например /favicon.svg
type string Тип значка, например image/svg+xml
sizes string Размер значка, например 256x256

Author

Наименование Тип Описание
name string Имя автора
url string Веб-сайт автора
email string Электронная почта автора
avatar string Аватар автора

Link

Наименование Тип Описание
text string Текст ссылки
url string Ссылка

RSS

Наименование Тип Описание
title string Заголовок, который может использоваться в некоторых шаблонах
size number Количество созданных статей

Index

Наименование Тип Описание
title string Заголовок. Можно использовать %d для обозначения номера текущей страницы
size number Количество созданных статей

Sitemap

Наименование Тип Описание
title string Заголовок, который может использоваться в некоторых шаблотах
enableTag boolean Указывать ли теги в sitemap
postPriority number Приоритет соответствующей статьи
postChangefreq string Частота изменения соответствующей статьи
priority number Приоритет других страниц
changefreq string Частота обновления других страниц

Agent

Наименование Тип Описание
agent []string Доступные сканеры, например ['*']
disallow []string Запрещённые каталоги
allow []string Разрешённые каталоги

Profile

Наименование Тип Описание
title string Заголовок с автоматически добавленным ###
footer string Нижний колонтитул с автоматически добавленными #####
size string Создать список статей указанного размера

Конфигурация генерирует контент, похожий на следующий:

### title

[post title](post link)
[post title](post link)
[post title](post link)  
##### footer

Теги

В blogit нет поддержки категорий статей или различий между страницами и статьями. Вместо этого используются теги для классификации и статистики статей.

Информация о тегах определяется в tags.yaml:

tags.yaml

Наименование Тип Описание
title string Заголовок страницы тегов
keywords string Значения тега meta.keywords в html>head страницы тегов. Если нет, то все теги используются как значение
description string Значение элемента meta.description в html>head страницы тегов
order string Порядок сортировки. Может быть asc или desc
orderType string Способ сортировки. Может быть size для сортировки по количеству связанных статей или пустым для сортировки по порядку добавления
tags []Tag Список тегов

Tag

Наименование

Здесь не хватает информации для полного перевода. Пожалуйста, уточните запрос.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/caixw-blogit.git
git@api.gitlife.ru:oschina-mirror/caixw-blogit.git
oschina-mirror
caixw-blogit
caixw-blogit
master