Mirror of HackMD with some custom changes

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Davide Depau 7b31ddecc3 Merge branch 'master' into DepauMD		4 years ago
bin	cleanup of the heroku configuration	4 years ago
docs	Slightly improve docker-linux-server.md	4 years ago
lib	Merge branch 'master' into DepauMD	4 years ago
locales	Merge branch 'master' into DepauMD	4 years ago
public	Merge branch 'master' into DepauMD	4 years ago
test	polyfilling scrypt for node 8.5+	4 years ago
.babelrc	drop node 6 support	4 years ago
.editorconfig	specifying the locale jsons to be in the exact style of poeditor should cut down on unneccessary changes ('churn')	4 years ago
.eslintignore	switching to eslint for code checking	5 years ago
.eslintrc.js	Add no-console as a warning	4 years ago
.gitignore	striving for consistency across various docs	4 years ago
.mailmap	Add mailmap for contributors	5 years ago
.sequelizerc.example	Create example config	7 years ago
.travis.yml	travis config is now in stages	4 years ago
AUTHORS	Fix file permission, remove useless executable	6 years ago
CHANGELOG.md	integrating information from the old wiki	4 years ago
CODE_OF_CONDUCT.md	moving code of conduct into its own file for better discoverability	4 years ago
CONTRIBUTING.md	Move DCO into docs section	4 years ago
LICENSE	Fix LICENSE content	4 years ago
README.md	Fix some minor quirks in the LinuxServer.io docs	4 years ago
app.js	Add vietnamese language	4 years ago
app.json	cleanup of the heroku configuration	4 years ago
config.json.example	Added a configuration option for passport-saml:	4 years ago
package.json	Merge branch 'master' into DepauMD	4 years ago
webpack.common.js	Merge branch 'master' into DepauMD	4 years ago
webpack.dev.js	Use webpack-merge.	5 years ago
webpack.htmlexport.js	Use webpack-merge.	5 years ago
webpack.prod.js	Use webpack-merge.	5 years ago
yarn.lock	Update yarn.lock	4 years ago

README.md

CodiMD

CodiMD lets you create real-time collaborative markdown notes. You can test-drive it by visiting our CodiMD demo server.

It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. A longer writeup can be read in the history doc.

Community and Contributions

We welcome contributions! There's a lot to do: If you would like to report bugs, the issue tracker is the right place. If you can help translating, find us on POEditor. To get started developing, take a look at the docs/dev directory. In any case: come talk to us, we'll be delighted to help you with the first steps.

To stay up to date with our work or get support it's recommended to join our Matrix channel, stop by our community forums or subscribe to the release feed. We also engage in regular community calls (RSS) which you are very welcome to join.

Installation / Upgrading

You can run CodiMD in a number of ways, and we created setup instructions for all of these:

If you do not wish to run your own setup, you can find a commercial offering at https://hackmd.io. This is not the same codebase as this one, but it is a very similar project.

Configuration

Theres two main ways to configure your CodiMD instance: Config file or environment variables. You can choose what works best for you.

CodiMD can integrate with

facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and oauth2 for login
imgur, s3, minio, azure for image/attachment storage (files can also be local!)
dropbox for export and import

More info about that can be found in the configuration docs above.