github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-03-25 02:34:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/README.md

104 lines
5.5 KiB
Markdown
Raw Normal View History

style: linting markdown files Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-07-01 09:52:17 +00:00
# CodiMD
First commit, version 0.2.7
2015-05-04 07:53:29 +00:00
Rebrand HackMD to CodiMD Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-22 19:07:30 +00:00
[![#CodiMD on matrix.org][matrix.org-image]][matrix.org-url]
Add travis ci
2017-02-15 10:14:58 +00:00
[![build status][travis-image]][travis-url]
Add version badge in README.md
2017-10-08 11:15:29 +00:00
[![version][github-version-badge]][github-release-page]
Extend README Add hint about file descriptor limits and add the new translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-04-11 07:38:45 +00:00
[![POEditor][poeditor-image]][poeditor-url]
add mastodon badge - partially fix #70 Signed-off-by: Amolith <amolith@nixnet.xyz>
2019-05-20 01:10:39 +00:00
[![Mastodon][social-mastodon-image]][social-mastodon]
Added Gitter badge
2015-08-15 04:15:42 +00:00
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
CodiMD lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [CodiMD demo server][codimd-demo].
striving for consistency across various docs Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 18:10:32 +00:00
Add note about renaming To make it more obvious for people, a note in the README as recommended by danyork[1] seems like a good idea. [1]: https://github.com/danyork Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2020-07-29 19:06:49 +00:00
**Note**: CodiMD is in the process of [changing its name to HedgeDoc](https://github.com/codimd/server/issues/452).
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD](https://hackmd.io) and now forked
into its own organisation. [A longer writeup can be read in the history doc](docs/history.md).
First commit, version 0.2.7
2015-05-04 07:53:29 +00:00
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
[![CodiMD 1.3.2 with its feature demonstration page open](docs/images/CodiMD-1.3.2-features.png)][codimd-demo-features]
Marked as 0.2.8
2015-05-15 04:58:13 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
## Community and Contributions
Add "Table of Contents" in README.md
2017-10-13 07:59:57 +00:00
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
We welcome contributions! There's a lot to do: If you would like to report bugs,
the [issue tracker][github-issue-tracker] is the right place. If you can help
translating, find us on [POEditor][poeditor-url]. To get started developing,
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us,
we'll be delighted to help you with the first steps.
Update README.md
2016-06-01 16:13:01 +00:00
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
To stay up to date with our work or get support it's recommended to join our
[Matrix channel][matrix.org-url], stop by our [community forums][codimd-community]
or subscribe to the [release feed][github-release-feed]. We also engage in
tiny correction to url. also adding RSS feed.
2019-04-03 22:34:23 +00:00
regular [community calls][codimd-community-calls] ([RSS](https://community.codimd.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
Add migration section to README.md As it was requested to be more visable, this commit adds a migration section about the introduced config style changes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-04-04 23:21:20 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
## Installation / Upgrading
Fix README markdown
2016-10-04 08:41:26 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
You can run CodiMD in a number of ways, and we created setup instructions for
all of these:
Reorganize README.md structure, cc #574
2017-10-08 11:37:20 +00:00
style: linting markdown files Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-07-01 09:52:17 +00:00
- [Docker](docs/setup/docker.md)
- [Kubernetes](docs/setup/kubernetes.md)
- [Cloudron](docs/setup/cloudron.md)
- [LinuxServer.io (multi-arch docker)](docs/setup/docker-linuxserver.md)
- [Heroku](docs/setup/heroku.md)
- [Manual setup](docs/setup/manual-setup.md)
Reorganize README.md structure, cc #574
2017-10-08 11:37:20 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
## Configuration
Fix README markdown
2016-10-04 08:41:26 +00:00
doc: merge configuration-config-file.md and configuration-env-vars.md to configuration.md Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-15 14:47:53 +00:00
Theres two main ways to [configure](docs/configuration.md) your CodiMD instance:
config file or environment variables. You can choose what works best for you.
Marked as 0.2.8
2015-05-15 04:58:13 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
CodiMD can integrate with
Fix README markdown
2016-10-04 08:41:26 +00:00
style: linting markdown files Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-07-01 09:52:17 +00:00
- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2](docs/guides/auth/oauth.md) **for login**
- imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
- dropbox **for export and import**
Rename environment variables and add legacy support. As we are no longer HackMD the short tag `HMD` doesn't match anymore. We move it to the matching prefix `CMD` and inform our users about the change. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-24 11:22:51 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
More info about that can be found in the configuration docs above.
Refactor server with Sequelize ORM, refactor server configs, now will show note status (created or updated) and support docs (note alias)
2016-04-20 10:03:55 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
## Browser support
Updated README.md
2016-03-15 03:30:43 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
To use CodiMD, your browser should match or exceed these versions:
Update README.md
2015-05-08 03:52:30 +00:00
Fix browser logo links Signed-off-by: Sandro Jäckel <sandro.jaeckel@gmail.com>
2020-06-26 07:41:34 +00:00
- ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome >= 47, ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome for Android >= 47
- ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari/safari_24x24.png) Safari >= 9, ![iOS Safarai](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari-ios/safari-ios_24x24.png) iOS Safari >= 8.4
- ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/firefox/firefox_24x24.png) Firefox >= 44
- ![IE](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/archive/internet-explorer_9-11/internet-explorer_9-11_24x24.png) IE >= 9, ![Edge](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/edge/edge_24x24.png) Edge >= 12
- ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/opera/opera_24x24.png) Opera >= 34, ![Opera Mini](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/opera-mini/opera-mini_24x24.png) Opera Mini not supported
- ![Android Browser](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/android-webview-beta/android-webview-beta_24x24.png) Android Browser >= 4.4
Reorganize README.md structure, cc #574
2017-10-08 11:37:20 +00:00
Document the backup process Signed-off-by: Augustin Trancart <augustin.trancart@oslandia.com>
2020-09-01 13:08:51 +00:00
## Backup/restore your instance
To backup codimd, you should:
- backup your database
- backup your custom config file if you have one
- backup the upload folder (see the [uploadsPath](./docs/configuration.md#codimd-paths-stuff) config directive)
Restoring an existing instance of codimd is then just a matter of restoring these elements.
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
## Related Tools
Our community has created related tools, we'd like to highlight [codimd-cli](https://github.com/codimd/cli)
which lets you use CodiMD from the comfort of your command line.
style: linting markdown files Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-07-01 09:52:17 +00:00
## License
Reorganize README.md structure, cc #574
2017-10-08 11:37:20 +00:00
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
Fix badges and links in README.md
2017-03-14 15:30:35 +00:00
Update matrix chat link from riot.im to app.element.io and change room alias Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-09-08 08:06:30 +00:00
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org
Change all element.io links to matrix.to links Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-09-28 11:05:22 +00:00
[matrix.org-url]: https://matrix.to/#/#hedgedoc:matrix.org
Fix some remaining references to the old repository Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-03-28 21:36:26 +00:00
[travis-image]: https://travis-ci.org/codimd/server.svg?branch=master
[travis-url]: https://travis-ci.org/codimd/server
[github-version-badge]: https://img.shields.io/github/release/codimd/server.svg
Update links to new repositories After a long discussion, it turned out that CodiMD as community project and HackMD as a company, have fundamental different views on the project governance. Due to this, it came to point where the decision for a fork was made. After the fork and move towards an own organisation, this patch updates all links inside the project to the new repositories. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-03-27 18:31:20 +00:00
[github-release-page]: https://github.com/codimd/server/releases
[github-release-feed]: https://github.com/codimd/server/releases.atom
splitting README.md into files in /docs for better readability Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-31 14:02:05 +00:00
[github-issue-tracker]: https://github.com/codimd/server/issues/
Fix possible file limit errors As we currently may need higher nofile limits than usual/default on various systems this commit should probide a fix for that an allow to build HackMD without highering these limits and increase security. Inspiration was found in a copy-webpack-plugin-issue[1] and found by @thegcat[2]. Thanks for that! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com> [1]: https://github.com/webpack-contrib/copy-webpack-plugin/issues/59#issuecomment-228563990 [2]: https://github.com/thegcat
2018-04-16 19:08:24 +00:00
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
Extend README Add hint about file descriptor limits and add the new translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-04-11 07:38:45 +00:00
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
more ways to engage with the community added to the readme Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-03 21:09:36 +00:00
[codimd-demo]: https://demo.codimd.org
[codimd-demo-features]: https://demo.codimd.org/features
[codimd-community]: https://community.codimd.org
tiny correction to url. also adding RSS feed.
2019-04-03 22:34:23 +00:00
[codimd-community-calls]: https://community.codimd.org/t/codimd-community-call/19
add mastodon badge - partially fix #70 Signed-off-by: Amolith <amolith@nixnet.xyz>
2019-05-20 01:10:39 +00:00
[social-mastodon]: https://social.codimd.org/mastodon
Update badge icons I just noticed that shields.io provides some nice new badges including one explicitly for Matrix and one for Mastodon. Since those are really our platforms, let's get them into our README. Just a cosmetic change. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-08-03 15:50:04 +00:00
[social-mastodon-image]: https://img.shields.io/mastodon/follow/18547?domain=https%3A%2F%2Fsocial.snopyta.org&style=social
Reference in a new issue Copy permalink