CodeX Docs — open-source приложение для документации

У вас когда-нибудь возникала потребность поднять простое приложение для внутренней или публичной информации?

Сегодня мы выпустили большое обновление и представили мировому сообществу наш движок CodeX Docs, который используется внутри команды уже больше года. В этом посте — немного подробностей о проекте.

CodeX Docs — сервис для работы с заметками. Простая установка, открытый исходных код, никаких ограничений. Проект основан на редакторе Editor.js и использует лучшие инструменты его экосистемы.

Когда мы выпускали Editor.js, возникла необходимость где-то писать и размещать документацию для разработчиков по использованию и настройке редактора. Мы в CodeX часто создаем инструменты для своих нужд и сами пользуемся своими продуктами. Так получилось и в этот раз — было решено писать документацию к редактору с помощью самого редактора, попутно лишний раз тестируя его.

Наш следующий релиз — open-source трекер ошибок Hawk также нуждался в документации, и тоже получил собственную копию CodeX Docs.

В то же время, внутри команды всевозможные документы мы писали в разных местаx: Apple Notes, Dropbox Paper, Google Docs, Notion. В какой-то момент проблема отсутствия Single Source of Truth стала слишком очевидной. Мы подняли копию CodeX Docs для внутренней документации. И это оказалось крайне удобно. Теперь все доки хранятся на space.codex.so, который закрыт от внешних посетителей с помощью Cloudflare Access.

Проект показал себя удобным и простым. Пришло время поделиться им с мировым сообществом.

В основе — редактор Editor.js, это наш крупный open-source проект, который недавно преодолел отметку в 20000 stars на GitHub.

Вокруг редактора сложилось большое сообщество пользователей и разработчиков плагинов. Лучше инструменты, расширения и библиотеки собраны в коллекции Awesome Editorjs. Все вместе они составляют экосистему Editor.js.

CodeX Docs построен на базе лучших решений экосистемы. Это всевозможные блоки редактора, плагины для настройки блоков, инструменты инлайн-форматирования.

Для работы проекта не требуется разворачивание сложной инфраструктуры, даже внешней базы данных. Все документы хранятся в виде JSON-файлов в папке .db

Документы можно вкладывать друг в друга, формируя разделы в сайдбаре. Менять порядок тоже, разумеется, можно. Каждой странице присваивается красивый URL, основанный на заголовке — это удобно для пользователей и хорошо для поисковой оптимизации.

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

Проект получился удобным и полезным. Он может вам пригодиться если вам нужен проект для хранения:

Возможно, этим юзкейсы не ограничиваются.

Мы создали Demo Docs, где можно потестировать все «в движении». Контент там очищается каждые несколько минут.

Сегодня CodeX Docs был опубликован на Product Hunt. Мы будем рады, если вы ознакомитесь и оставите обратную связь.