Bxnotes | bxnotes.ru

О проекте

Bxnotes – это open source контентная площадка для разработчиков.

Что за контент на сайте?

Основной контент – это краткие конспекты книг/курсов/статей и личный опыт.

Как это работает?

Контент сайт bxnotes.ru генерируется из директории content.

Движок сайта находится в директории _server.

При коммите в мастер, сайт bxnotes.ru пересобирается.

Как происходит сборка сайта?

Для сборки используется движок статических сайтов eleventy.

На основе директории content строится меню, страницы, навигация по сайту.

Файлы формата markdown переводятся в html.

Структура и содержание директории content

Структура директорий content:

1. секция
2. тема
3. конспект
4. статья конспекта

Файлы index.md содержат информацию о родительской директории для генерации тайтлов и сео тегов.

В директории нижнего уровня находятся посты в md формате.

Запуск dev сервера и редактирование сайта

1. Установить NodeJS
2. Форкнуть и клонировать репозиторий
3. yarn install (установить зависимости)
4. yarn dev (запустить dev сервер)
5. Открыть в браузере http://localhost:8080
6. Отредактировать нужную информацию в директории content

Вопросы и предложения

https://github.com/ValeriyDyachenko/bxnotes/issues