Bxnotes | bxnotes.ru

О чем

Bxnotes – это информация для веб-разработчиков. Здесь вы найдете конспекты книг, курсов, статей и личный опыт. Основной критерий, это краткая подача информации без воды.

Технологии

Сайт написан на React и GatsbyJS.

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

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

Чтобы пропустить пересборку сайта, то в название коммита следует добавить фразу [ci skip].

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

Директория content содержит поддиректории и md файлы. Глубина их вложенности соответствует следующим элементам:

1. категория
2. подкатегория
3. конспект
4. статья

На каждом уровне могут находиться только элементы одного типа.

В данный момент, сборщик сайта ориентируется на структуру из 4 уровней вложенности. В дальнейшем, планируется его доработать, чтобы он не был привязан к жесткой структуре и строил навигацию по принципу:

категория -> ...подкатегории -> статья

Публикация изменений

Если вы нашли неточность в изложении материала или опечатку - достаточно отправить pull request, содержащий исправление.

Если изменение вносит какую-то более существенную доработку в область контента или логики работы сайта, то предварительно создайте issue для обсуждения деталей.

Запуска дев сервера

1. Форкните репозиторий
2. npm install (установить зависимости)
3. gatsby develop (запустить dev сервер)
4. Открыть в браузере http://localhost:8000

Правила оформления PR

• Название ветки и коммита должны кратко отражать суть изменений.
• Если в процессе работы у вас получилось несколько коммитов, перед публикацией, объедините их в 1.

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

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