Skip to content
CodiMD - Realtime collaborative markdown notes on all platforms.
JavaScript HTML CSS Other
Branch: develop
Clone or download

Latest commit

Yukaii Merge pull request #1530 from hackmdio/fix/improve-filesystem-upload
fix: improve image upload to filesystem may caused app crash
Latest commit 7b14845 Jun 1, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin prevert directly call of User.hashPassword() Apr 19, 2020
contribute Add sign you work section in contributing and DCO Oct 11, 2017
deployments chore: change image version to 2.1.0 in docker-compose example May 18, 2020
lib fix: improve image upload to filesystem may caused app crash May 30, 2020
locales Update pandoc i18n Feb 29, 2020
public Update to make editor have extra scroll padding in the bottom Jun 1, 2020
test fix: extractProfileAttribute not working correctly Feb 27, 2020
utils refactor: fix lint warning on utils/string.js Apr 12, 2019
.babelrc Upgrade to Webpack 4 - first try Sep 6, 2018
.buildpacks Added Scalingo compatible deployment Nov 29, 2019
.dockerignore feat: add new dockerfile Oct 7, 2019
.editorconfig Update editorconfig Mar 31, 2017
.gitignore Drop yarn Feb 17, 2020
.mailmap Add mailmap for contributors Jul 27, 2018
.nvmrc chore: add .nvmrc to fix node version May 18, 2020
.sequelizerc.example feat: add new dockerfile Oct 7, 2019
.travis.yml update minimal required node version to 10 (Debnium) Apr 19, 2020
AUTHORS Fix file permission, remove useless executable Dec 13, 2017
CONTRIBUTING.md Rebrand HackMD to CodiMD Jun 24, 2018
LICENSE Change license from MIT to AGPLv3 Oct 11, 2017
Procfile fix: heroku Proffile might show sensitive data in log Mar 2, 2020
README.md Update README.md to avoid confusion Apr 1, 2020
app.js Fix session flood issue after prometheus metrics are implemented. May 4, 2020
app.json fix: change heroku and scalingo config schema for 2.0.0 Mar 2, 2020
config.json.example also use gfm header generation in test and debug configuraitons Oct 29, 2019
package-lock.json chore: bump 2.1.0 May 18, 2020
package.json chore: bump 2.1.0 May 18, 2020
scalingo.json fix: change heroku and scalingo config schema for 2.0.0 Mar 2, 2020
webpack.common.js Bundle default leaflet marker images Feb 27, 2020
webpack.dev.js Use webpack-merge. Oct 10, 2018
webpack.htmlexport.js Use webpack-merge. Oct 10, 2018
webpack.prod.js Use webpack-merge. Oct 10, 2018

README.md

CodiMD

build status version Gitter 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 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

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:

  • Chrome Chrome >= 47, Chrome for Android >= 47
  • Safari Safari >= 9, iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • IE / Edge IE >= 9, Edge >= 12
  • Opera Opera >= 34, Opera Mini not supported
  • Android Browser >= 4.4

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

License

License under AGPL.

You can’t perform that action at this time.