Конфигурация
Все настройки сайта живут в одном файле — markdown-publish.config.json в корне репозитория (рядом с папкой заметок).
{
"siteName": "Мои заметки",
"siteDescription": "Конспекты и идеи",
"siteLang": "ru",
"siteUrl": "https://ник.github.io/репозиторий",
"siteFooter": "",
"vaultDir": "vault",
"buildMode": "full",
"baseHref": "/",
"out": "dist"
}
Что значит каждый ключ
| Ключ | Что делает | По умолчанию |
|---|---|---|
siteName |
Название в шапке и в <title> |
имя папки vault |
siteDescription |
Описание для поисковиков и соцсетей | — |
siteLang |
Язык контента (ru, en, …) |
en |
siteUrl |
Полный адрес сайта — нужен для sitemap и OG-карточек | — |
siteFooter |
Подпись внизу сайдбара (пусто — не показывается) | — |
vaultDir |
Папка с заметками внутри репозитория | . (корень) |
buildMode |
full — публикуются все заметки; public — только с publish: public во frontmatter |
full |
baseHref |
Под-путь сайта. Для GitHub Pages — /имя-репозитория/, для Netlify/Vercel/Cloudflare — / |
/ |
out |
Куда складывать собранный сайт | dist |
Приоритет настроек
Флаги CLI перекрывают переменные окружения, те — конфиг-файл, тот — значения по умолчанию.
Скрытые заметки
В режиме buildMode: public публикуются только заметки, у которых в начале файла есть:
---
publish: public
---
Остальные не попадут ни на сайт, ни в поиск, ни в граф.
Главная грабля — baseHref
Если сайт открывается, но выглядит сломанным и заметки не грузятся — почти наверняка дело в baseHref. См. FAQ.