codimd README

The project's README from github.com/hackmdio/codimd. As one markdown file: README.md.

CodiMD

build status version Gitter Matrix POEditor

CodiMD lets you collaborate in real-time with markdown. Built on HackMD source code, CodiMD lets you host and control your team's content with speed and ease.

screenshot

Table of Contents

HackMD

HackMD helps developers write better documents and build active communities with open collaboration. HackMD is built with one promise - You own and control all your content:

CodiMD - The Open Source HackMD

CodiMD is the free software version of HackMD, developed and open sourced by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data. (See the origin of the name CodiMD.)

CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases.

HackMD team is committed to keep CodiMD open source. All contributions are welcome!

Documentation

You would find all documentation here: CodiMD Documentation

Deployment

If you want to spin up an instance and start using immediately, see Docker deployment. If you want to contribute to the project, start with manual deployment.

Configuration

CodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in CodiMD Configuration.

Upgrading and Migration

Upgrade CodiMD from previous version? See this guide
Migrating from Etherpad? Follow this guide

Developer

Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, to build your changes with the help of webpack.

Contribution and Discussion

All contributions are welcome! Even asking a question helps.

Project Contribution Types Contribution Venue
CodiMD :couple: Community chat Gitter
:bug: Issues, bugs, and feature requests Issue tracker
:books: Improve documentation Documentations
:pencil: Translation POEditor
:coffee: Donation Buy us coffee
HackMD :question: Issues related to HackMD Issue tracker
:pencil2: Translation hackmd-locales

Browser Support

CodiMD is a service that runs on Node.js, while users use the service through browsers. We support your users using the following browsers:

To stay up to date with your installation it's recommended to subscribe the release feed.

License

License under AGPL.

codimd (hackmdio/codimd)

Searching Database…

10.2K ·GitHub
Что это такое?Веб-приложение для самостоятельного размещения (self-hosted) для совместной работы над заметками в markdown в реальном времени — бесплатная версия HackMD с открытым исходным кодом. Ваша команда или сообщество пишет вместе прямо в браузере, а данные полностью остаются под вашим контролем.
Чем он отличается от HackMD?Это проект с открытым исходным кодом от команды HackMD, созданный на основе кода HackMD, но без некоторых функций — режим book mode есть только в HackMD. CodiMD подходит для открытых сообществ, а HackMD добавляет управление правами и доступом для коммерческого использования.
Как запустить свой собственный экземпляр?Самый быстрый способ — развёртывание через Docker: поднимаете экземпляр и сразу начинаете им пользоваться. Для разработки разверните вручную на Node.js и выполните 'sequelize db:migrate && node app.js'.
Что нужно на сервере, чтобы его запустить?Node.js версии от 14 до 16 (в engines закреплено >=14.0.0 <17.0.0) и база данных — стартовый скрипт сначала запускает миграции Sequelize. Пользователям нужен только браузер.
Какие браузеры понадобятся моим пользователям?Хватит и старых версий: Chrome 47+, Firefox 44+, Edge 12+, Opera 34+, Safari 9+ (iOS Safari 8.4+) и Android Browser 4.4+. Opera Mini не поддерживается.
Кому принадлежат заметки, хранящиеся на моём экземпляре?Вам — всё своё онлайн-содержимое можно скачать разом, а markdown сохраняет форматирование переносимым между системами. И презентации тоже остаются под вашим контролем — через HTML и режим слайдов.
Что можно настроить в своём экземпляре?Конфигурация очень гибкая: для сети, безопасности, производительности, ресурсов, привилегий, приватности, хранения изображений и аутентификации в документации по настройке CodiMD отведены отдельные разделы.
Где могут храниться загруженные изображения?В кодовой базе есть интеграции с Amazon S3, Azure Storage и Imgur, так что место хранения загружаемых изображений можно выбрать под свою инфраструктуру.
Можно ли перенести свои заметки из Etherpad?Да — есть отдельное руководство по миграции с Etherpad, а также руководство по обновлению старых экземпляров CodiMD до новых версий.
Можно не только писать заметки, но и показывать их как презентацию?Да — помимо отображения в HTML, заметки можно показывать в режиме слайдов. Режим book mode есть только в коммерческом HackMD, в CodiMD его нет.
Creator
hackmdio
Size
28.2 MB
Stars
10.2K
Age
11y
Commits · 90 Days