Mirror of HackMD with some custom changes
Find a file
Sheogorath 788d8ca933
Fix some minor quirks in the LinuxServer.io docs
The current documents might end up confusing people and are not
completely accessible. This minor fixes should clear up the situation
and add alt texts to all badges, explain the links at the end of the
docs, and list LinuxServer.io in the supported provider section of the
README.

Some reasoning on the change in the listing:
Since we maintain an own container image which is for sure kept updated
on release, this is our first listing, as well as general solutions that
are build on that image, like the K8s integration.

The next listings are integrated provides which allow self-hosting, like
Cloudron and I also consider LinuxServer.io as this kind of providers.
Which try to enable people to run CodiMD on their own hardware or rented
servers in a very easy way, but by using their own images.

As third category I would look at hosted offers, like Heroku, which are
not completely SaaS but far enough away from the self-hostability that
I consider them as an own category. PaaS-based solutions are not as
FOSS-style as we want our setups to be, but of course still supported.

Finally the manual setup. We keep it down here, because we support it,
but don't recommend it in general. It's hard to upgrade and can cause
problems when dependencies are not correctly updated or people don't run
the db migrations.

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-08-01 20:03:07 +02:00
bin
docs Fix some minor quirks in the LinuxServer.io docs 2019-08-01 20:03:07 +02:00
lib Rework debug logging 2019-06-08 21:27:29 +02:00
locales Add vietnamese language 2019-05-26 05:34:52 +02:00
public Merge pull request #97 from SISheogorath/fix/linting 2019-06-04 16:09:46 +02:00
test polyfilling scrypt for node 8.5+ 2019-05-13 19:37:21 +02:00
.babelrc drop node 6 support 2019-05-13 19:37:21 +02:00
.editorconfig specifying the locale jsons to be in the exact style of poeditor should cut down on unneccessary changes ('churn') 2019-04-04 12:31:38 +02:00
.eslintignore
.eslintrc.js Add no-console as a warning 2019-05-12 20:15:46 +02:00
.gitignore striving for consistency across various docs 2019-04-01 01:03:36 +02:00
.mailmap
.sequelizerc.example
.travis.yml travis config is now in stages 2019-05-13 19:37:22 +02:00
app.js Add vietnamese language 2019-05-26 05:34:52 +02:00
app.json
AUTHORS
CHANGELOG.md
CODE_OF_CONDUCT.md moving code of conduct into its own file for better discoverability 2019-04-01 01:26:42 +02:00
config.json.example Added a configuration option for passport-saml: 2019-04-06 17:54:58 +02:00
CONTRIBUTING.md Move DCO into docs section 2019-06-10 17:35:36 +02:00
LICENSE
package.json Merge pull request #97 from SISheogorath/fix/linting 2019-06-04 16:09:46 +02:00
README.md Fix some minor quirks in the LinuxServer.io docs 2019-08-01 20:03:07 +02:00
webpack.common.js Remove sass-loader, to avoid confusion 2019-05-12 20:15:46 +02:00
webpack.dev.js
webpack.htmlexport.js
webpack.prod.js
yarn.lock Update yarn.lock 2019-05-30 00:10:44 +02:00

CodiMD

#CodiMD on matrix.org build status version POEditor Mastodon

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.

CodiMD 1.3.2 with its feature demonstration page open

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.

Browser support

To use CodiMD, your browser should match or exceed these versions:

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

Our community has created related tools, we'd like to highlight codimd-cli which lets you use CodiMD from the comfort of your command line.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.