База знаний
Veelim's storiesВ течении жизни приходится решать задачи, связанные с работой или личными увлечениями, которые в будущем имеют тенденцию повторяться, а решения, и если они комплексные невозможно удержать в голове на длительный срок. И чтобы каждый раз не ломать голову, вспоминая, что и как делать, необходимо сохранить знания, полученные в ходе решения проблемы. Важно сохранить готовое решение, а непросто ссылку или документ.
Многие для этого используют Google документы, Excel таблицы или текстовые файлы. Но как по мне эти инструменты созданы не для этого. Чтобы организовать свою базу знаний я решил выдвинуть ряд требований:
- Форматирование в Markdown
- Разделение на каталоги (это очень удобно, чтобы не делать из хранилища свалку)
- Минималистичный внешний вид
Всем мои требованиям удовлетворяет сервис GitBook. Его можно найти прямо на Github и развернуть на своем сервере или воспользоваться подпиской. Я выбрал первый вариант и развернул его локально. Синхронизацию между устройствами можно организовать через любое облачное хранилище. Ниже приведу инструкцию, которая уже есть в моей базе знаний.
How to install GitBook local
Requirement version of software:
- NodeJS 10x or below
Install with NPM
npm install gitbook-cli -g
Create a book
gitbook init
Create file book.json with this content
{ "root": "./docs", "title": "DMKB", "author": "Veelim", "description": "My knowledge base", "plugins": [ "folding-chapters-2", "theme-code", "-sharing" ], "pluginsConfig": { "theme-default": { "showLevel": false } } }
Install modules by command
gitbook install
Move README.md and SUMMARY.md to docs folder
Preview and serve book
gitbook serve
SUMMARY.md file structure
- Folder * [Article title](link to md file)
Так это выглядит