# 什么是codimd？

Codimd是一个开源项目，可实现多人同时编辑MarkDown文档。它是Hackmd的开源版本，只有最基本的功能，如注册登录、创建、编辑、分享文档，还有权限控制，但是并没有后台管理功能。这对于团队之间分享文档是个不错的选择。

功能

1、注册登录

可以使用邮箱注册登录，也可以配置使用github或gitlab登录。（可以配置自己公司的gitlab账号登录）

2、编辑文档

任何登录用户都可以创建文档并分享给其他人，如果他人有编辑此文档的权限，那么他也可以一起编辑此文档。

3、导出文档

文档可以导出成多种格式，如md, html, pdf等。

4、权限控制

可以控制文档的可见度和编辑权限。

部署codimd

codimd可部署在自己的服务器上，建议使用docker部署，简单快捷。

github地址：GitHub - hackmdio/codimd: CodiMD - Realtime collaborative markdown notes on all platforms.

docker部署教程：Docker Deployment - HackMD （需要翻墙）

docker-compose 示例：

version: "3"
services:
  database:
    image: postgres:11.6-alpine
    environment:
      - POSTGRES_USER=codimd
      - POSTGRES_PASSWORD=change_password
      - POSTGRES_DB=codimd
    volumes:
      - "database-data:/var/lib/postgresql/data"
    restart: always
  codimd:
    image: hackmdio/hackmd:2.4.2
    environment:
      - CMD_DB_URL=postgres://codimd:change_password@database/codimd
      - CMD_USECDN=false
    depends_on:
      - database
    ports:
      - "3000:3000"
    volumes:
      - upload-data:/home/hackmd/app/public/uploads
    restart: always
volumes:
  database-data: {}
  upload-data: {}

这是我自己部署的codimd，大家可以体验一下：https://md.lushaoming.cn/