Bxnotes – это информация для веб-разработчиков. Здесь вы найдете конспекты книг, курсов, статей и личный опыт. Основной критерий, это краткая подача информации без воды.
Сайт написан на React и GatsbyJS.
На основе md файлов из директории content строится меню, страницы и навигация по сайту.
При коммите в мастер, сайт пересобирается и публикуется.
Чтобы пропустить пересборку сайта, то в название коммита следует добавить фразу [ci skip].
Директория content содержит поддиректории и md файлы. Глубина их вложенности соответствует следующим элементам:
- категория
- подкатегория
- конспект
- статья
На каждом уровне могут находиться только элементы одного типа.
В данный момент, сборщик сайта ориентируется на структуру из 4 уровней вложенности. В дальнейшем, планируется его доработать, чтобы он не был привязан к жесткой структуре и строил навигацию по принципу:
категория -> ...подкатегории -> статья
Если вы нашли неточность в изложении материала или опечатку - достаточно отправить pull request, содержащий исправление.
Если изменение вносит какую-то более существенную доработку в область контента или логики работы сайта, то предварительно создайте issue для обсуждения деталей.
- Форкните репозиторий
npm install(установить зависимости)gatsby develop(запустить dev сервер)- Открыть в браузере
http://localhost:8000
- Название ветки и коммита должны кратко отражать суть изменений.
- Если в процессе работы у вас получилось несколько коммитов, перед публикацией, объедините их в 1.