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
这是什么?一个自托管的网页应用,用于多人实时协作编写 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,笔记还能以幻灯片模式展示。书籍模式只存在于商业版 HackMD 中,CodiMD 没有。
Creator
hackmdio
Size
28.2 MB
Stars
10.2K
Age
11y
Commits · 90 Days