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

Go to file

Lucas Druschke bcd92f500f return errorForbidden when anonymous user tries to create freeUrl pad (closes #1499 ) Signed-off-by: Lucas Druschke <ldruschk@posteo.de>		2020-04-29 22:42:56 +02:00
bin	prevert directly call of User.hashPassword()	2020-04-20 00:04:13 +08:00
contribute	…
deployments	chore: dump version to 2.0.0	2020-03-03 00:00:02 +08:00
lib	return errorForbidden when anonymous user tries to create freeUrl pad (closes #1499 )	2020-04-29 22:42:56 +02:00
locales	Update pandoc i18n	2020-02-29 18:43:20 +08:00
public	Support brace wrapped param in fence lang	2020-04-19 16:52:24 +08:00
test	fix: extractProfileAttribute not working correctly	2020-02-28 01:53:25 +08:00
utils	refactor: fix lint warning on utils/string.js	2019-04-12 18:00:23 +08:00
.babelrc	…
.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	…
.gitignore	Drop yarn	2020-02-17 11:41:33 +08:00
.mailmap	…
.sequelizerc.example	feat: add new dockerfile	2019-10-07 15:42:03 +08:00
.travis.yml	update minimal required node version to 10 (Debnium)	2020-04-20 00:04:12 +08:00
AUTHORS	…
CONTRIBUTING.md	…
LICENSE	…
Procfile	fix: heroku Proffile might show sensitive data in log	2020-03-02 23:51:40 +08:00
README.md	Update README.md to avoid confusion	2020-04-01 10:37:00 +08:00
app.js	refactor: change errorNotFound function signature to avoid parameter passing error	2020-02-26 11:20:42 +08:00
app.json	fix: change heroku and scalingo config schema for 2.0.0	2020-03-02 23:05:55 +08:00
config.json.example	also use gfm header generation in test and debug configuraitons	2019-10-29 10:00:34 +01:00
package-lock.json	remove scrypt && install scrypt-kdf	2020-04-20 00:04:12 +08:00
package.json	update minimal required node version to 10 (Debnium)	2020-04-20 00:04:12 +08:00
scalingo.json	fix: change heroku and scalingo config schema for 2.0.0	2020-03-02 23:05:55 +08:00
webpack.common.js	Bundle default leaflet marker images	2020-02-27 21:51:10 +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

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.

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

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.

CodiMD - The Open Source HackMD

CodiMD is the free software version of HackMD, developed and opened source 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	👫 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