CodiMD - Realtime collaborative markdown notes on all platforms. https://hackmd.io/c/codimd-documentation

Go to file

Yukai Huang 89ff0b6b1c Fix coding style Signed-off-by: Yukai Huang <yukaihuangtw@gmail.com>		2020-02-05 14:51:16 +08:00
bin	Check for falsy existingUser variable. Fixes #1369	2019-12-05 15:35:33 +01:00
contribute	Add sign you work section in contributing and DCO	2017-10-12 01:44:55 +08:00
deployments	postgresql upgrade(11.5 -> 11.6)	2020-01-15 20:17:28 +09:00
docs	Fix several typos in auth/saml.md	2019-02-15 04:14:17 +08:00
lib	refactor: noteActions	2020-01-06 14:19:03 +08:00
locales	translation: Fix some translations in zh-TW	2019-05-01 18:52:40 +08:00
public	Fix coding style	2020-02-05 14:51:16 +08:00
test	refactor: move realtime related code to directory	2020-01-06 14:19:02 +08:00
utils	refactor: fix lint warning on utils/string.js	2019-04-12 18:00:23 +08:00
.babelrc	Upgrade to Webpack 4 - first try	2018-09-06 17:26:09 +02:00
.buildpacks	Added Scalingo compatible deployment	2019-11-29 11:52:01 +01:00
.dockerignore	feat: add new dockerfile	2019-10-07 15:42:03 +08:00
.editorconfig	Update editorconfig	2017-03-31 20:58:58 +08:00
.gitignore	feat: add nyc for unit test code coverage	2019-05-27 17:53:02 +08:00
.mailmap	Add mailmap for contributors	2018-07-27 13:21:52 +02:00
.sequelizerc.example	feat: add new dockerfile	2019-10-07 15:42:03 +08:00
.travis.yml	ci: update	2019-05-27 18:35:35 +08:00
AUTHORS	Fix file permission, remove useless executable	2017-12-14 05:05:18 +08:00
CONTRIBUTING.md	Rebrand HackMD to CodiMD	2018-06-24 13:24:12 +02:00
LICENSE	Change license from MIT to AGPLv3	2017-10-12 01:45:57 +08:00
README.md	Update README.md	2019-12-30 15:55:21 +08:00
app.js	refactor: remove web folder	2020-01-06 14:19:02 +08:00
app.json	Add environment variables definition for Heroku deploy.	2019-12-28 22:23:20 +09:00
config.json.example	also use gfm header generation in test and debug configuraitons	2019-10-29 10:00:34 +01:00
package.json	chore: update maintainers list	2020-01-06 14:37:46 +08:00
scalingo.json	Add environment variables definition for Scalingo deploy.	2019-12-28 23:24:16 +09:00
webpack.common.js	Add more editor themes	2020-01-31 15:53:29 +08:00
webpack.dev.js	Use webpack-merge.	2018-10-10 22:09:46 +02:00
webpack.htmlexport.js	Use webpack-merge.	2018-10-10 22:09:46 +02:00
webpack.prod.js	Use webpack-merge.	2018-10-10 22:09:46 +02:00
yarn.lock	chore: upgrade sequelize	2020-01-06 14:19:02 +08:00

README.md

CodiMD

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.

CodiMD - The Open Source HackMD
Documentation
Contribution and Discussion
Browser Support
License

CodiMD - The Open Source 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:

You should be able to easily download all your online content at once.
Your content formatting should be portable as well. (That's why we choose markdown.)
You should be able to control your content's presentation with HTML, slide mode, or book mode.

With the same promise of you owning your content, CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features, so you can use CodiMD for your community and own 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	👫 Community chat	Gitter
	🐛 Issues, bugs, and feature requests	Issue tracker
	📚 Improve documentation	Documentations
	📝 Translation	POEditor
	☕ Donation	Buy us coffee
HackMD	❓ Issues related to HackMD	Issue tracker
	✏️ Translation	hackmd-locales