Merge pull request #850 from SISheogorath/rebrand/CodiMD

Rebrand HackMD CE to CodiMD
This commit is contained in:
Christoph (Sheogorath) Kern 2018-06-26 21:38:02 +02:00 committed by GitHub
commit 6634fac849
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
41 changed files with 436 additions and 1174 deletions

View file

@ -56,7 +56,7 @@ version 1.2.0, available at
### Sign your work
We use the Developer Certificate of Origin (DCO) as a additional safeguard
for the HackMD project. This is a well established and widely used
for the CodiMD project. This is a well established and widely used
mechanism to assure contributors have confirmed their right to license
their contribution under the project's license.
Please read [contribute/developer-certificate-of-origin][dcofile].

View file

@ -1,902 +0,0 @@
=== .babelrc
Yukai Huang <yukaihuangtw@gmail.com>
=== .editorconfig
bananaappletw <bananaappletw@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== .gitignore
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== .sequelizerc.example
Yukai Huang <yukaihuangtw@gmail.com>
=== .travis.yml
bananaappletw <bananaappletw@gmail.com>
BoHong Li <a60814billy@gmail.com>
Max Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
=== AUTHORS
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== CONTRIBUTING.md
Max Wu <jackymaxj@gmail.com>
=== LICENSE
Cheng-Han, Wu <jackymaxj@gmail.com>
jackycute <jacky_cute0808@hotmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== README.md
alecdwm <alec@owls.io>
bananaappletw <bananaappletw@gmail.com>
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Florian Rhiem <florian.rhiem@gmail.com>
jackycute <jackymaxj@gmail.com>
Jannik Lorenz <dev@janniklorenz.de>
Jason Croft <jcroft@velocity.org>
Johannes Weißl <jargon@molb.org>
Jun SAKATA <jun.bj141400@gmail.com>
Laura Kyle <laura.kyle91@gmail.com>
Max Wu <jackymaxj@gmail.com>
neopostmodern <clemens@neopostmodern.com>
NV <nvsofts@gmail.com>
Sheogorath <sheogorath@shivering-isles.com>
The Gitter Badger <badger@gitter.im>
Wonder Chang <iwonder.tw@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
蒼時弦也 <elct9620@frost.tw>
=== app.js
alecdwm <alec@owls.io>
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
James Stephenson <c4p7.fl1n7@gmail.com>
Jan Kunzmann <jan-github@phobia.de>
Jason Croft <jcroft@velocity.org>
Jordan Matelsky <j6k4m8@gmail.com>
knjcode <knjcode@gmail.com>
LluisArevalo <thorin119@gmail.com>
Max Wu <jackymaxj@gmail.com>
NV <nvsofts@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Raccoon Li <a60814billy@gmail.com>
robert <ahmerov.rt@molodost.bz>
Sheogorath <sheogorath@shivering-isles.com>
S.Noda <noda@fenrir.co.jp>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== app.json
bananaappletw <bananaappletw@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== bin/heroku
bananaappletw <bananaappletw@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== bin/setup
Sheogorath <sheogorath@shivering-isles.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== config.json.example
alecdwm <alec@owls.io>
bananaappletw <bananaappletw@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/bucket-policy-editor.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/bucket-property.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/create-bucket.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/custom-policy.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/iam-user.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/images/s3-image-upload/review-policy.png
Yukai Huang <yukaihuangtw@gmail.com>
=== docs/guides/s3-image-upload.md
Johannes Weißl <jargon@molb.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== lib/config/default.js
BoHong Li <a60814billy@gmail.com>
=== lib/config/defaultSSL.js
BoHong Li <a60814billy@gmail.com>
=== lib/config/dockerSecret.js
BoHong Li <a60814billy@gmail.com>
=== lib/config/enum.js
BoHong Li <a60814billy@gmail.com>
=== lib/config/environment.js
BoHong Li <a60814billy@gmail.com>
Raccoon Li <a60814billy@gmail.com>
=== lib/config/index.js
BoHong Li <a60814billy@gmail.com>
tkykm <tkykm@users.noreply.github.com>
=== lib/config/oldEnvironment.js
BoHong Li <a60814billy@gmail.com>
Raccoon Li <a60814billy@gmail.com>
=== lib/config/utils.js
Raccoon Li <a60814billy@gmail.com>
=== lib/history.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/letter-avatars.js
alecdwm <alec@owls.io>
BoHong Li <a60814billy@gmail.com>
=== lib/logger.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/migrations/20150504155329-create-users.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20150508114741-create-notes.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20150515125813-create-temp.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20150702001020-update-to-0_3_1.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20150915153700-change-notes-title-to-text.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20160112220142-note-add-lastchange.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20160420180355-note-add-alias.js
BoHong Li <a60814billy@gmail.com>
=== lib/migrations/20160515114000-user-add-tokens.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
=== lib/migrations/20160607060246-support-revision.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/migrations/20160703062241-support-authorship.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/migrations/20161009040430-support-delete-note.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/migrations/20161201050312-support-email-signin.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/models/author.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/models/index.js
bananaappletw <bananaappletw@gmail.com>
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== lib/models/note.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
NV <nvsofts@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
蒼時弦也 <elct9620@frost.tw>
=== lib/models/revision.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/models/temp.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
=== lib/models/user.js
alecdwm <alec@owls.io>
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/client.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/editor-socketio-server.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/index.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/selection.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/server.js
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/simple-text-operation.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/text-operation.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/ot/wrapped-operation.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== lib/realtime.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Florian Rhiem <florian.rhiem@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
蒼時弦也 <elct9620@frost.tw>
=== lib/response.js
alecdwm <alec@owls.io>
BoHong Li <a60814billy@gmail.com>
butlerx <butlerx@notthe.cloud>
Cheng-Han, Wu <jackymaxj@gmail.com>
Florian Rhiem <florian.rhiem@gmail.com>
Ikumi Shimizu <193s@users.noreply.github.com>
Jannik Lorenz <dev@janniklorenz.de>
Jason Croft <jcroft@velocity.org>
Sheogorath <sheogorath@shivering-isles.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
蒼時弦也 <elct9620@frost.tw>
=== lib/utils.js
BoHong Li <a60814billy@gmail.com>
butlerx <butlerx@notthe.cloud>
LluisArevalo <thorin119@gmail.com>
=== lib/web/auth/dropbox/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/email/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/facebook/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/github/index.js
BoHong Li <a60814billy@gmail.com>
Max Wu <jackymaxj@gmail.com>
=== lib/web/auth/gitlab/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/google/index.js
BoHong Li <a60814billy@gmail.com>
Kaiyu Shi <skyisno.1@gmail.com>
=== lib/web/auth/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/ldap/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/twitter/index.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/auth/utils.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/baseRouter.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/historyRouter.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/imageRouter.js
BoHong Li <a60814billy@gmail.com>
Kotaro Yamamoto <kota.crk@gmail.com>
Raccoon Li <a60814billy@gmail.com>
=== lib/web/middleware/checkURIValid.js
BoHong Li <a60814billy@gmail.com>
Max Wu <jackymaxj@gmail.com>
=== lib/web/middleware/redirectWithoutTrailingSlashes.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/middleware/tooBusy.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/noteRouter.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/statusRouter.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/userRouter.js
BoHong Li <a60814billy@gmail.com>
=== lib/web/utils.js
BoHong Li <a60814billy@gmail.com>
=== lib/workers/dmpWorker.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== locales/ca.json
Xavier Marques <xaviermarques4f@gmail.com>
=== locales/da.json
Patrick Andersen <patrick@bacha.dk>
=== locales/de.json
Jannik Lorenz <dev@janniklorenz.de>
Philipp Zumstein <zuphilip@users.noreply.github.com>
Simon Joda Stößer <SimJoSt@users.noreply.github.com>
=== locales/el.json
Stratos Gerakakis <stratosgear@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
zachariast <zachariastraianos@gmail.com>
=== locales/en.json
alecdwm <alec@owls.io>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== locales/eo.json
James Stephenson <c4p7.fl1n7@gmail.com>
=== locales/es.json
Pablo Guerrero <pablo.guerrero@sap.com>
Sergio Valverde <svg153@users.noreply.github.com>
=== locales/fr.json
Colin Maudry <colin@maudry.com>
Ho33e5 <ho33e5@gmail.com>
=== locales/hi.json
Paras <paraschadha2052@gmail.com>
=== locales/hr.json
ivanorsolic <ivanorsolic@users.noreply.github.com>
=== locales/it.json
GhiMax <ghina8@gmail.com>
=== locales/ja.json
tkqubo <tk.qubo@gmail.com>
=== locales/nl.json
Martijnpold <martijntje7@gmail.com>
Tom Wyckhuys <tomwyckhuys@gmail.com>
=== locales/pl.json
Bartlomiej Szala <fenix440@gmail.com>
Jakub Sygnowski <sygnowski@gmail.com>
=== locales/pt.json
Marcelo Alencar <marceloalves@ufpa.br>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== locales/ru.json
Himura Kazuto <Himura2la@users.noreply.github.com>
p0v1n0m <p0v1n0m@gmail.com>
=== locales/sv.json
Lars Karlsson <lars@kajes.se>
Patrick Andersen <patrick@bacha.dk>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== locales/tr.json
Ömer Erdinç Yağmurlu <omeryagmurlu@gmail.com>
=== locales/uk.json
Dmytro Kytsmen <dmitrokytsmen@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== locales/zh.json
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== package.json
alecdwm <alec@owls.io>
bananaappletw <bananaappletw@gmail.com>
BoHong Li <a60814billy@gmail.com>
Bryan Davis <bd808@wikimedia.org>
Cheng-Han, Wu <jackymaxj@gmail.com>
Fabien Meghazi <agr@amigrave.com>
greenkeeperio-bot <support@greenkeeper.io>
Jason Croft <jcroft@velocity.org>
Max Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Peter Dave Hello <PeterDaveHello@users.noreply.github.com>
Sheogorath <sheogorath@shivering-isles.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/apple-touch-icon.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/bootstrap-social.css
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/center.css
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/cover.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/extra.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/font.css
Yukai Huang <yukaihuangtw@gmail.com>
=== public/css/github-extract.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/google-font.css
Yukai Huang <yukaihuangtw@gmail.com>
=== public/css/index.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/markdown.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/mermaid.css
Cheng-Han, Wu <jackymaxj@gmail.com>
=== public/css/site.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/css/slide-preview.css
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/css/slide.css
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/default.md
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/docs/features.md
Cheng-Han, Wu <jackymaxj@gmail.com>
Max Wu <jackymaxj@gmail.com>
Pablo Guerrero <pablo.guerrero@gmail.com>
Sheogorath <sheogorath@shivering-isles.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/docs/release-notes.md
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/docs/slide-example.md
butlerx <butlerx@notthe.cloud>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/docs/yaml-metadata.md
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/favicon.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/fonts/SourceCodePro-Black.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Black.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Black.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Bold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Bold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Bold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-ExtraLight.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-ExtraLight.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-ExtraLight.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Light.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Light.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Light.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Medium.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Medium.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Medium.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Regular.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Regular.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Regular.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Semibold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Semibold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceCodePro-Semibold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Black.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Black.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Black.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BlackItalic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BlackItalic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BlackItalic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Bold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Bold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Bold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BoldItalic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BoldItalic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-BoldItalic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLight.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLight.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLight.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLightItalic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLightItalic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-ExtraLightItalic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Italic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Italic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Italic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Light.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Light.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Light.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-LightItalic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-LightItalic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-LightItalic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Regular.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Regular.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Regular.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Semibold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Semibold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-Semibold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-SemiboldItalic.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-SemiboldItalic.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSansPro-SemiboldItalic.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Bold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Bold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Bold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Regular.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Regular.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Regular.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Semibold.eot
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Semibold.ttf
Peter Dave Hello <hsu@peterdavehello.org>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/fonts/SourceSerifPro-Semibold.woff
Yukai Huang <yukaihuangtw@gmail.com>
=== public/hackmd-icon-1024.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/js/cover.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
NV <nvsofts@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/extra.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
NV <nvsofts@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/google-drive-picker.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Max Wu <jackymaxj@gmail.com>
=== public/js/google-drive-upload.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/js/history.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/htmlExport.js
BoHong Li <a60814billy@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/index.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
Laura Kyle <laura.kyle91@gmail.com>
NV <nvsofts@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
Zankio <xxoojoeooxx1@gmail.com>
蒼時弦也 <elct9620@frost.tw>
=== public/js/lib/appState.js
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/common/constant.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/js/lib/common/login.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/config/index.js
BoHong Li <a60814billy@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/editor/config.js
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/editor/index.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/editor/statusbar.html
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/editor/ui-elements.js
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/editor/utils.js
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/modeType.js
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/lib/syncscroll.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/locale.js
BoHong Li <a60814billy@gmail.com>
Peter Dave Hello <PeterDaveHello@users.noreply.github.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/pretty.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/render.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/js/reveal-markdown.js
BoHong Li <a60814billy@gmail.com>
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/js/slide.js
BoHong Li <a60814billy@gmail.com>
Max Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/screenshot.png
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/uploads/.gitkeep
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/vendor/abcjs_basic_3.1.1-min.js
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/bootstrap/tooltip.min.css
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/bootstrap/tooltip.min.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/codemirror-spell-checker/en_US.aff
Cheng-Han, Wu <jackymaxj@gmail.com>
=== public/vendor/codemirror-spell-checker/en_US.dic
Cheng-Han, Wu <jackymaxj@gmail.com>
=== public/vendor/codemirror-spell-checker/spell-checker.min.css
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/codemirror-spell-checker/spell-checker.min.js
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/vendor/inlineAttachment/codemirror.inline-attachment.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/inlineAttachment/inline-attachment.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-textcomplete/jquery.textcomplete.js
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_flat_0_aaaaaa_40x100.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_flat_75_ffffff_40x100.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_glass_55_fbf9ee_1x400.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_glass_65_ffffff_1x400.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_glass_75_dadada_1x400.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_glass_75_e6e6e6_1x400.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_glass_95_fef1ec_1x400.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-bg_highlight-soft_75_cccccc_1x100.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-icons_222222_256x240.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-icons_2e83ff_256x240.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-icons_454545_256x240.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-icons_888888_256x240.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/images/ui-icons_cd0a0a_256x240.png
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/jquery-ui.min.css
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/jquery-ui/jquery-ui.min.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/md-toc.js
BoHong Li <a60814billy@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/ajax-adapter.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/client.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/codemirror-adapter.js
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/compress.sh
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/editor-client.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/ot.min.js
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/selection.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/socketio-adapter.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/text-operation.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/undo-manager.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/ot/wrapped-operation.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/showup/showup.css
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/vendor/showup/showup.js
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/error.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/hackmd.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/hackmd/body.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Florian Rhiem <florian.rhiem@gmail.com>
Ian Dees <ian.dees@gmail.com>
Jason Croft <jcroft@velocity.org>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
蒼時弦也 <elct9620@frost.tw>
=== public/views/hackmd/foot.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Jannik Lorenz <dev@janniklorenz.de>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/hackmd/footer.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/hackmd/head.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/hackmd/header.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Jannik Lorenz <dev@janniklorenz.de>
Jason Croft <jcroft@velocity.org>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
=== public/views/html.hbs
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/includes/header.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/includes/scripts.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/index.ejs
alecdwm <alec@owls.io>
Cheng-Han, Wu <jackymaxj@gmail.com>
Florian Rhiem <florian.rhiem@gmail.com>
James Stephenson <c4p7.fl1n7@gmail.com>
Jannik Lorenz <dev@janniklorenz.de>
Jason Croft <jcroft@velocity.org>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/index/body.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/index/foot.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/index/footer.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/index/head.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
xnum <s000032001@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/index/header.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/pretty.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== public/views/shared/disqus.ejs
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/ga.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/help-modal.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/polyfill.ejs
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/refresh-modal.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/revision-modal.ejs
Cheng-Han, Wu <jackymaxj@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/shared/signin-modal.ejs
alecdwm <alec@owls.io>
Cheng-Han, Wu <jackymaxj@gmail.com>
Jason Croft <jcroft@velocity.org>
neopostmodern <clemens@neopostmodern.com>
Sheogorath <sheogorath@shivering-isles.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== public/views/slide.ejs
butlerx <butlerx@notthe.cloud>
Cheng-Han, Wu <jackymaxj@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== tmp/.keep
Wu Cheng-Han <jacky_cute0808@hotmail.com>
=== webpack.config.js
BoHong Li <a60814billy@gmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== webpack.production.js
BoHong Li <a60814billy@gmail.com>
geekyd <singhsince94@gmail.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== webpackBaseConfig.js
BoHong Li <a60814billy@gmail.com>
Peter Dave Hello <hsu@peterdavehello.org>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>
=== yarn.lock
BoHong Li <a60814billy@gmail.com>
Christian Schuhmann <madebyherzblut@users.noreply.github.com>
Wu Cheng-Han <jacky_cute0808@hotmail.com>
Yukai Huang <yukaihuangtw@gmail.com>

217
README.md
View file

@ -1,18 +1,18 @@
HackMD Community Edition
CodiMD
===
[![Standard - JavaScript Style Guide][standardjs-image]][standardjs-url]
[![Join the chat at https://gitter.im/hackmdio/hackmd][gitter-image]][gitter-url]
[![#HackMD on matrix.org][matrix.org-image]][matrix.org-url]
[![#CodiMD on matrix.org][matrix.org-image]][matrix.org-url]
[![build status][travis-image]][travis-url]
[![version][github-version-badge]][github-release-page]
[![Help Contribute to Open Source][codetriage-image]][codetriage-url]
[![POEditor][poeditor-image]][poeditor-url]
HackMD lets you create realtime collaborative markdown notes on all platforms.
Inspired by Hackpad, with more focus on speed and flexibility.
Still in the early stage, feel free to fork or contribute to HackMD.
CodiMD lets you create real-time collaborative markdown notes on all platforms.
Inspired by Hackpad, with more focus on speed and flexibility, and build from [HackMD](https://hackmd.io) source code.
Feel free to contribute.
Thanks for using! :smile:
@ -20,6 +20,7 @@ Thanks for using! :smile:
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Table of Contents
- [HackMD CE became CodiMD](#hackmd-ce-became-codimd)
- [Browsers Requirement](#browsers-requirement)
- [Installation](#installation)
- [Getting started (Native install)](#getting-started-native-install)
@ -27,7 +28,7 @@ Thanks for using! :smile:
- [Instructions](#instructions)
- [Heroku Deployment](#heroku-deployment)
- [Kubernetes](#kubernetes)
- [HackMD by docker container](#hackmd-by-docker-container)
- [CodiMD by docker container](#codimd-by-docker-container)
- [Upgrade](#upgrade)
- [Native setup](#native-setup)
- [Configuration](#configuration)
@ -42,6 +43,16 @@ Thanks for using! :smile:
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# HackMD CE became CodiMD
CodiMD was recently renamed from its former name was HackMD. CodiMD is the free software version of HackMD. It was the original Version of HackMD. The HackMD team initiated CodiMD and provided a solid code base. Due to the need of paying bills, A fork was created and called HackMD EE, which is a SaaS (Software as a Service) product available at [hackmd.io](https://hackmd.io).
We decided to change the name to break the confusion between HackMD and CodiMD, formally known as HackMD CE, as it never was an open core project.
Just to more confusion: We are still friends with HackMD :heart:
*For the whole renaming story, see the [related issue](https://github.com/hackmdio/hackmd/issues/720)*
# Browsers Requirement
- ![Chrome](http://browserbadge.com/chrome/47/18px) Chrome >= 47, Chrome for Android >= 47
@ -60,7 +71,7 @@ Thanks for using! :smile:
- Node.js 6.x or up (test up to 7.5.0)
- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8`
- npm (and its dependencies, especially [uWebSockets](https://github.com/uWebSockets/uWebSockets#nodejs-developers), [node-gyp](https://github.com/nodejs/node-gyp#installation))
- For **building** HackMD we recommend to use a machine with at least **2GB** RAM
- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
### Instructions
@ -73,9 +84,9 @@ Thanks for using! :smile:
## Heroku Deployment
You can quickly setup a sample Heroku HackMD application by clicking the button below.
You can quickly setup a sample Heroku CodiMD application by clicking the button below.
[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hackmdio/hackmd/tree/master)
[![Deploy on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/hackmdio/codimd/tree/master)
If you deploy it without the button, keep in mind to use the right buildpacks. For details check `app.json`.
@ -83,10 +94,10 @@ If you deploy it without the button, keep in mind to use the right buildpacks. F
To install use `helm install stable/hackmd`.
For all further details, please check out the offical HackMD [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd).
For all further details, please check out the offical CodiMD [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd).
## HackMD by docker container
[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/hackmdio/docker-hackmd/raw/master/docker-compose.yml&stack_name=hackmd)
## CodiMD by docker container
[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/hackmdio/docker-hackmd/raw/master/docker-compose.yml&stack_name=codimd)
**Debian-based version:**
@ -98,11 +109,11 @@ For all further details, please check out the offical HackMD [K8s helm chart](h
[![alpine](https://images.microbadger.com/badges/version/hackmdio/hackmd:alpine.svg)](https://microbadger.com/images/hackmdio/hackmd:alpine "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/image/hackmdio/hackmd:alpine.svg)](https://microbadger.com/images/hackmdio/hackmd:alpine "Get your own image badge on microbadger.com")
The easiest way to setup HackMD using docker are using the following three commands:
The easiest way to setup CodiMD using docker are using the following three commands:
```console
git clone https://github.com/hackmdio/docker-hackmd.git
cd docker-hackmd
cd docker-codimd
docker-compose up
```
Read more about it in the [docker repository…](https://github.com/hackmdio/docker-hackmd)
@ -111,14 +122,14 @@ Read more about it in the [docker repository…](https://github.com/hackmdio/doc
## Native setup
If you are upgrading HackMD from an older version, follow these steps:
If you are upgrading CodiMD from an older version, follow these steps:
1. Fully stop your old server first (important)
2. `git pull` or do whatever that updates the files
3. `npm install` to update dependencies
4. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development)
5. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string
For example: `postgres://username:password@localhost:5432/hackmd`
For example: `postgres://username:password@localhost:5432/codimd`
6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema
7. Start your whole new server!
@ -154,80 +165,82 @@ There are some config settings you need to change in the files below.
| --------- | ------ | ----------- |
| `NODE_ENV` | `production` or `development` | set current environment (will apply corresponding settings in the `config.json`) |
| `DEBUG` | `true` or `false` | set debug mode; show more logs |
| `HMD_DOMAIN` | `hackmd.io` | domain name |
| `HMD_URL_PATH` | `hackmd` | sub URL path, like `www.example.com/<URL_PATH>` |
| `HMD_PORT` | `80` | web app port |
| `HMD_ALLOW_ORIGIN` | `localhost, hackmd.io` | domain name whitelist (use comma to separate) |
| `HMD_PROTOCOL_USESSL` | `true` or `false` | set to use SSL protocol for resources path (only applied when domain is set) |
| `HMD_URL_ADDPORT` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
| `HMD_USECDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
| `HMD_ALLOW_ANONYMOUS` | `true` or `false` | set to allow anonymous usage (default is `true`) |
| `HMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | if `allowAnonymous` is `true`, allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
| `HMD_ALLOW_FREEURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
| `HMD_DEFAULT_PERMISSION` | `freely`, `editable`, `limited`, `locked` or `private` | set notes default permission (only applied on signed users) |
| `HMD_DB_URL` | `mysql://localhost:3306/database` | set the database URL |
| `HMD_SESSION_SECRET` | no example | Secret used to sign the session cookie. If non is set, one will randomly generated on startup |
| `HMD_SESSION_LIFE` | `1209600000` | Session life time. (milliseconds) |
| `HMD_FACEBOOK_CLIENTID` | no example | Facebook API client id |
| `HMD_FACEBOOK_CLIENTSECRET` | no example | Facebook API client secret |
| `HMD_TWITTER_CONSUMERKEY` | no example | Twitter API consumer key |
| `HMD_TWITTER_CONSUMERSECRET` | no example | Twitter API consumer secret |
| `HMD_GITHUB_CLIENTID` | no example | GitHub API client id |
| `HMD_GITHUB_CLIENTSECRET` | no example | GitHub API client secret |
| `HMD_GITLAB_SCOPE` | `read_user` or `api` | GitLab API requested scope (default is `api`) (GitLab snippet import/export need `api` scope) |
| `HMD_GITLAB_BASEURL` | no example | GitLab authentication endpoint, set to use other endpoint than GitLab.com (optional) |
| `HMD_GITLAB_CLIENTID` | no example | GitLab API client id |
| `HMD_GITLAB_CLIENTSECRET` | no example | GitLab API client secret |
| `HMD_MATTERMOST_BASEURL` | no example | Mattermost authentication endpoint |
| `HMD_MATTERMOST_CLIENTID` | no example | Mattermost API client id |
| `HMD_MATTERMOST_CLIENTSECRET` | no example | Mattermost API client secret |
| `HMD_DROPBOX_CLIENTID` | no example | Dropbox API client id |
| `HMD_DROPBOX_CLIENTSECRET` | no example | Dropbox API client secret |
| `HMD_GOOGLE_CLIENTID` | no example | Google API client id |
| `HMD_GOOGLE_CLIENTSECRET` | no example | Google API client secret |
| `HMD_LDAP_URL` | `ldap://example.com` | URL of LDAP server |
| `HMD_LDAP_BINDDN` | no example | bindDn for LDAP access |
| `HMD_LDAP_BINDCREDENTIALS` | no example | bindCredentials for LDAP access |
| `HMD_LDAP_SEARCHBASE` | `o=users,dc=example,dc=com` | LDAP directory to begin search from |
| `HMD_LDAP_SEARCHFILTER` | `(uid={{username}})` | LDAP filter to search with |
| `HMD_LDAP_SEARCHATTRIBUTES` | `displayName, mail` | LDAP attributes to search with (use comma to separate) |
| `HMD_LDAP_USERIDFIELD` | `uidNumber` or `uid` or `sAMAccountName` | The LDAP field which is used uniquely identify a user on HackMD |
| `HMD_LDAP_USERNAMEFIELD` | Fallback to userid | The LDAP field which is used as the username on HackMD |
| `HMD_LDAP_TLS_CA` | `server-cert.pem, root.pem` | Root CA for LDAP TLS in PEM format (use comma to separate) |
| `HMD_LDAP_PROVIDERNAME` | `My institution` | Optional name to be displayed at login form indicating the LDAP provider |
| `HMD_SAML_IDPSSOURL` | `https://idp.example.com/sso` | authentication endpoint of IdP. for details, see [guide](docs/guides/auth.md#saml-onelogin). |
| `HMD_SAML_IDPCERT` | `/path/to/cert.pem` | certificate file path of IdP in PEM format |
| `HMD_SAML_ISSUER` | no example | identity of the service provider (optional, default: serverurl)" |
| `HMD_SAML_IDENTIFIERFORMAT` | no example | name identifier format (optional, default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`) |
| `HMD_SAML_GROUPATTRIBUTE` | `memberOf` | attribute name for group list (optional) |
| `HMD_SAML_REQUIREDGROUPS` | `Hackmd-users` | group names that allowed (use vertical bar to separate) (optional) |
| `HMD_SAML_EXTERNALGROUPS` | `Temporary-staff` | group names that not allowed (use vertical bar to separate) (optional) |
| `HMD_SAML_ATTRIBUTE_ID` | `sAMAccountName` | attribute map for `id` (optional, default: NameID of SAML response) |
| `HMD_SAML_ATTRIBUTE_USERNAME` | `mailNickname` | attribute map for `username` (optional, default: NameID of SAML response) |
| `HMD_SAML_ATTRIBUTE_EMAIL` | `mail` | attribute map for `email` (optional, default: NameID of SAML response if `HMD_SAML_IDENTIFIERFORMAT` is default) |
| `HMD_IMGUR_CLIENTID` | no example | Imgur API client id |
| `HMD_EMAIL` | `true` or `false` | set to allow email signin |
| `HMD_ALLOW_PDF_EXPORT` | `true` or `false` | Enable or disable PDF exports |
| `HMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
| `HMD_ALLOW_GRAVATAR` | `true` or `false` | set to `false` to disable gravatar as profile picture source on your instance |
| `HMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](docs/guides/s3-image-upload.md) or [Minio](docs/guides/minio-image-upload.md) |
| `HMD_S3_ACCESS_KEY_ID` | no example | AWS access key id |
| `HMD_S3_SECRET_ACCESS_KEY` | no example | AWS secret key |
| `HMD_S3_REGION` | `ap-northeast-1` | AWS S3 region |
| `HMD_S3_BUCKET` | no example | AWS S3 bucket name |
| `HMD_MINIO_ACCESS_KEY` | no example | Minio access key |
| `HMD_MINIO_SECRET_KEY` | no example | Minio secret key |
| `HMD_MINIO_ENDPOINT` | `minio.example.org` | Address of your Minio endpoint/instance |
| `HMD_MINIO_PORT` | `9000` | Port that is used for your Minio instance |
| `HMD_MINIO_SECURE` | `true` | If set to `true` HTTPS is used for Minio |
| `HMD_AZURE_CONNECTION_STRING` | no example | Azure Blob Storage connection string |
| `HMD_AZURE_CONTAINER` | no example | Azure Blob Storage container name (automatically created if non existent) |
| `HMD_HSTS_ENABLE` | ` true` | set to enable [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) if HTTPS is also enabled (default is ` true`) |
| `HMD_HSTS_INCLUDE_SUBDOMAINS` | `true` | set to include subdomains in HSTS (default is `true`) |
| `HMD_HSTS_MAX_AGE` | `31536000` | max duration in seconds to tell clients to keep HSTS status (default is a year) |
| `HMD_HSTS_PRELOAD` | `true` | whether to allow preloading of the site's HSTS status (e.g. into browsers) |
| `HMD_CSP_ENABLE` | `true` | whether to enable Content Security Policy (directives cannot be configured with environment variables) |
| `HMD_CSP_REPORTURI` | `https://<someid>.report-uri.com/r/d/csp/enforce` | Allows to add a URL for CSP reports in case of violations |
| `CMD_DOMAIN` | `codimd.org` | domain name |
| `CMD_URL_PATH` | `codimd` | sub URL path, like `www.example.com/<URL_PATH>` |
| `CMD_PORT` | `80` | web app port |
| `CMD_ALLOW_ORIGIN` | `localhost, codimd.org` | domain name whitelist (use comma to separate) |
| `CMD_PROTOCOL_USESSL` | `true` or `false` | set to use SSL protocol for resources path (only applied when domain is set) |
| `CMD_URL_ADDPORT` | `true` or `false` | set to add port on callback URL (ports `80` or `443` won't be applied) (only applied when domain is set) |
| `CMD_USECDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
| `CMD_ALLOW_ANONYMOUS` | `true` or `false` | set to allow anonymous usage (default is `true`) |
| `CMD_ALLOW_ANONYMOUS_EDITS` | `true` or `false` | if `allowAnonymous` is `true`, allow users to select `freely` permission, allowing guests to edit existing notes (default is `false`) |
| `CMD_ALLOW_FREEURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
| `CMD_DEFAULT_PERMISSION` | `freely`, `editable`, `limited`, `locked` or `private` | set notes default permission (only applied on signed users) |
| `CMD_DB_URL` | `mysql://localhost:3306/database` | set the database URL |
| `CMD_SESSION_SECRET` | no example | Secret used to sign the session cookie. If non is set, one will randomly generated on startup |
| `CMD_SESSION_LIFE` | `1209600000` | Session life time. (milliseconds) |
| `CMD_FACEBOOK_CLIENTID` | no example | Facebook API client id |
| `CMD_FACEBOOK_CLIENTSECRET` | no example | Facebook API client secret |
| `CMD_TWITTER_CONSUMERKEY` | no example | Twitter API consumer key |
| `CMD_TWITTER_CONSUMERSECRET` | no example | Twitter API consumer secret |
| `CMD_GITHUB_CLIENTID` | no example | GitHub API client id |
| `CMD_GITHUB_CLIENTSECRET` | no example | GitHub API client secret |
| `CMD_GITLAB_SCOPE` | `read_user` or `api` | GitLab API requested scope (default is `api`) (GitLab snippet import/export need `api` scope) |
| `CMD_GITLAB_BASEURL` | no example | GitLab authentication endpoint, set to use other endpoint than GitLab.com (optional) |
| `CMD_GITLAB_CLIENTID` | no example | GitLab API client id |
| `CMD_GITLAB_CLIENTSECRET` | no example | GitLab API client secret |
| `CMD_MATTERMOST_BASEURL` | no example | Mattermost authentication endpoint |
| `CMD_MATTERMOST_CLIENTID` | no example | Mattermost API client id |
| `CMD_MATTERMOST_CLIENTSECRET` | no example | Mattermost API client secret |
| `CMD_DROPBOX_CLIENTID` | no example | Dropbox API client id |
| `CMD_DROPBOX_CLIENTSECRET` | no example | Dropbox API client secret |
| `CMD_GOOGLE_CLIENTID` | no example | Google API client id |
| `CMD_GOOGLE_CLIENTSECRET` | no example | Google API client secret |
| `CMD_LDAP_URL` | `ldap://example.com` | URL of LDAP server |
| `CMD_LDAP_BINDDN` | no example | bindDn for LDAP access |
| `CMD_LDAP_BINDCREDENTIALS` | no example | bindCredentials for LDAP access |
| `CMD_LDAP_SEARCHBASE` | `o=users,dc=example,dc=com` | LDAP directory to begin search from |
| `CMD_LDAP_SEARCHFILTER` | `(uid={{username}})` | LDAP filter to search with |
| `CMD_LDAP_SEARCHATTRIBUTES` | `displayName, mail` | LDAP attributes to search with (use comma to separate) |
| `CMD_LDAP_USERIDFIELD` | `uidNumber` or `uid` or `sAMAccountName` | The LDAP field which is used uniquely identify a user on CodiMD |
| `CMD_LDAP_USERNAMEFIELD` | Fallback to userid | The LDAP field which is used as the username on CodiMD |
| `CMD_LDAP_TLS_CA` | `server-cert.pem, root.pem` | Root CA for LDAP TLS in PEM format (use comma to separate) |
| `CMD_LDAP_PROVIDERNAME` | `My institution` | Optional name to be displayed at login form indicating the LDAP provider |
| `CMD_SAML_IDPSSOURL` | `https://idp.example.com/sso` | authentication endpoint of IdP. for details, see [guide](docs/guides/auth.md#saml-onelogin). |
| `CMD_SAML_IDPCERT` | `/path/to/cert.pem` | certificate file path of IdP in PEM format |
| `CMD_SAML_ISSUER` | no example | identity of the service provider (optional, default: serverurl)" |
| `CMD_SAML_IDENTIFIERFORMAT` | no example | name identifier format (optional, default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`) |
| `CMD_SAML_GROUPATTRIBUTE` | `memberOf` | attribute name for group list (optional) |
| `CMD_SAML_REQUIREDGROUPS` | `Hackmd-users` | group names that allowed (use vertical bar to separate) (optional) |
| `CMD_SAML_EXTERNALGROUPS` | `Temporary-staff` | group names that not allowed (use vertical bar to separate) (optional) |
| `CMD_SAML_ATTRIBUTE_ID` | `sAMAccountName` | attribute map for `id` (optional, default: NameID of SAML response) |
| `CMD_SAML_ATTRIBUTE_USERNAME` | `mailNickname` | attribute map for `username` (optional, default: NameID of SAML response) |
| `CMD_SAML_ATTRIBUTE_EMAIL` | `mail` | attribute map for `email` (optional, default: NameID of SAML response if `CMD_SAML_IDENTIFIERFORMAT` is default) |
| `CMD_IMGUR_CLIENTID` | no example | Imgur API client id |
| `CMD_EMAIL` | `true` or `false` | set to allow email signin |
| `CMD_ALLOW_PDF_EXPORT` | `true` or `false` | Enable or disable PDF exports |
| `CMD_ALLOW_EMAIL_REGISTER` | `true` or `false` | set to allow email register (only applied when email is set, default is `true`. Note `bin/manage_users` might help you if registration is `false`.) |
| `CMD_ALLOW_GRAVATAR` | `true` or `false` | set to `false` to disable gravatar as profile picture source on your instance |
| `CMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](docs/guides/s3-image-upload.md) or [Minio](docs/guides/minio-image-upload.md) |
| `CMD_S3_ACCESS_KEY_ID` | no example | AWS access key id |
| `CMD_S3_SECRET_ACCESS_KEY` | no example | AWS secret key |
| `CMD_S3_REGION` | `ap-northeast-1` | AWS S3 region |
| `CMD_S3_BUCKET` | no example | AWS S3 bucket name |
| `CMD_MINIO_ACCESS_KEY` | no example | Minio access key |
| `CMD_MINIO_SECRET_KEY` | no example | Minio secret key |
| `CMD_MINIO_ENDPOINT` | `minio.example.org` | Address of your Minio endpoint/instance |
| `CMD_MINIO_PORT` | `9000` | Port that is used for your Minio instance |
| `CMD_MINIO_SECURE` | `true` | If set to `true` HTTPS is used for Minio |
| `CMD_AZURE_CONNECTION_STRING` | no example | Azure Blob Storage connection string |
| `CMD_AZURE_CONTAINER` | no example | Azure Blob Storage container name (automatically created if non existent) |
| `CMD_HSTS_ENABLE` | ` true` | set to enable [HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) if HTTPS is also enabled (default is ` true`) |
| `CMD_HSTS_INCLUDE_SUBDOMAINS` | `true` | set to include subdomains in HSTS (default is `true`) |
| `CMD_HSTS_MAX_AGE` | `31536000` | max duration in seconds to tell clients to keep HSTS status (default is a year) |
| `CMD_HSTS_PRELOAD` | `true` | whether to allow preloading of the site's HSTS status (e.g. into browsers) |
| `CMD_CSP_ENABLE` | `true` | whether to enable Content Security Policy (directives cannot be configured with environment variables) |
| `CMD_CSP_REPORTURI` | `https://<someid>.report-uri.com/r/d/csp/enforce` | Allows to add a URL for CSP reports in case of violations |
***Note:** Due to the rename process we renamed all `HMD_`-prefix variables to be `CMD_`-prefixed. The old ones continue to work.*
## Application settings `config.json`
@ -235,7 +248,7 @@ There are some config settings you need to change in the files below.
| --------- | ------ | ----------- |
| `debug` | `true` or `false` | set debug mode, show more logs |
| `domain` | `localhost` | domain name |
| `urlPath` | `hackmd` | sub URL path, like `www.example.com/<urlpath>` |
| `urlPath` | `codimd` | sub URL path, like `www.example.com/<urlpath>` |
| `port` | `80` | web app port |
| `allowOrigin` | `['localhost']` | domain name whitelist |
| `useSSL` | `true` or `false` | set to use SSL server (if `true`, will auto turn on `protocolUseSSL`) |
@ -249,9 +262,9 @@ There are some config settings you need to change in the files below.
| `allowFreeURL` | `true` or `false` | set to allow new note creation by accessing a nonexistent note URL |
| `defaultPermission` | `freely`, `editable`, `limited`, `locked`, `protected` or `private` | set notes default permission (only applied on signed users) |
| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then db config (below) won't be applied |
| `db` | `{ "dialect": "sqlite", "storage": "./db.hackmd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
| `db` | `{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) |
| `sslKeyPath` | `./cert/client.key` | SSL key path (only need when you set `useSSL`) |
| `sslCertPath` | `./cert/hackmd_io.crt` | SSL cert path (only need when you set `useSSL`) |
| `sslCertPath` | `./cert/codimd_io.crt` | SSL cert path (only need when you set `useSSL`) |
| `sslCAPath` | `['./cert/COMODORSAAddTrustCA.crt']` | SSL ca chain (only need when you set `useSSL`) |
| `dhParamPath` | `./cert/dhparam.pem` | SSL dhparam path (only need when you set `useSSL`) |
| `tmpPath` | `./tmp/` | temp directory path |
@ -304,7 +317,7 @@ There are some config settings you need to change in the files below.
## Structure
```text
hackmd/
codimd/
├── tmp/ --- temporary files
├── docs/ --- document files
├── lib/ --- server libraries
@ -330,15 +343,15 @@ See more at [http://operational-transformation.github.io/](http://operational-tr
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
[gitter-url]: https://gitter.im/hackmdio/hackmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[matrix.org-image]: https://img.shields.io/badge/Matrix.org-%23HackMD@matrix.org-green.svg
[matrix.org-url]: https://riot.im/app/#/room/#hackmd:matrix.org
[travis-image]: https://travis-ci.org/hackmdio/hackmd.svg?branch=master
[travis-url]: https://travis-ci.org/hackmdio/hackmd
[github-version-badge]: https://img.shields.io/github/release/hackmdio/hackmd.svg
[github-release-page]: https://github.com/hackmdio/hackmd/releases
[matrix.org-image]: https://img.shields.io/badge/Matrix.org-%23CodiMD@matrix.org-green.svg
[matrix.org-url]: https://riot.im/app/#/room/#codimd:matrix.org
[travis-image]: https://travis-ci.org/hackmdio/codimd.svg?branch=master
[travis-url]: https://travis-ci.org/hackmdio/codimd
[github-version-badge]: https://img.shields.io/github/release/hackmdio/codimd.svg
[github-release-page]: https://github.com/hackmdio/codimd/releases
[standardjs-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standardjs-url]: https://github.com/feross/standard
[codetriage-image]: https://www.codetriage.com/hackmdio/hackmd/badges/users.svg
[codetriage-url]: https://www.codetriage.com/hackmdio/hackmd
[codetriage-image]: https://www.codetriage.com/hackmdio/codimd/badges/users.svg
[codetriage-url]: https://www.codetriage.com/hackmdio/codimd
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir

3
app.js
View file

@ -163,6 +163,7 @@ app.use(passport.session())
app.use(require('./lib/web/middleware/checkURIValid'))
// redirect url without trailing slashes
app.use(require('./lib/web/middleware/redirectWithoutTrailingSlashes'))
app.use(require('./lib/web/middleware/codiMDVersion'))
// routes need sessions
// template files
@ -234,7 +235,7 @@ process.on('uncaughtException', function (err) {
// install exit handler
function handleTermSignals () {
logger.info('hackmd has been killed by signal, try to exit gracefully...')
logger.info('CodiMD has been killed by signal, try to exit gracefully...')
realtime.maintenance = true
// disconnect all socket.io clients
Object.keys(io.sockets.sockets).forEach(function (key) {

View file

@ -1,5 +1,5 @@
{
"name": "HackMD",
"name": "CodiMD",
"description": "Realtime collaborative markdown notes on all platforms",
"keywords": [
"Collaborative",
@ -7,8 +7,8 @@
"Notes"
],
"website": "https://hackmd.io",
"repository": "https://github.com/hackmdio/hackmd",
"logo": "https://github.com/hackmdio/hackmd/raw/master/public/hackmd-icon-1024.png",
"repository": "https://github.com/hackmdio/codimd",
"logo": "https://github.com/hackmdio/codimd/raw/master/public/codimd-icon-1024.png",
"success_url": "/",
"env": {
"BUILD_ASSETS": {

View file

@ -33,11 +33,10 @@ BUILD_ASSETS=false npm install
cat << EOF
Edit the following config file to setup hackmd server and client.
Read more info at https://github.com/hackmdio/hackmd#configuration-files
Edit the following config file to setup CodiMD server and client.
Read more info at https://github.com/hackmdio/codimd#configuration-files
* config.json -- server config
* public/js/config.js -- client config
* config.json -- CodiMD config
* .sequelizerc -- db config
EOF

View file

@ -11,7 +11,7 @@
},
"db": {
"dialect": "sqlite",
"storage": "./db.hackmd.sqlite"
"storage": "./db.codimd.sqlite"
}
},
"production": {
@ -34,7 +34,7 @@
"db": {
"username": "",
"password": "",
"database": "hackmd",
"database": "codimd",
"host": "localhost",
"port": "5432",
"dialect": "postgres"

View file

@ -1,6 +1,8 @@
Authentication guide - GitHub
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. Sign-in or sign-up for a GitHub account
2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab
3. Click on the **New OAuth App** button, to create a new OAuth App:

View file

@ -1,6 +1,8 @@
# GitLab (self-hosted)
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. Sign in to your GitLab
2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required)
3. Click **New application** to create a new application and fill out the registration form:

View file

@ -1,6 +1,8 @@
Authentication guide - SAML (OneLogin)
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks)
2. Go to the administration page.
3. Select the **APPS** menu and click on the **Add Apps**.

View file

@ -1,6 +1,8 @@
Authentication guide - SAML
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
The basic procedure is the same as the case of OneLogin which is mentioned in [OneLogin-Guide](./saml-onelogin.md). If you want to match your IdP, you can use more configurations as below.
* If your IdP accepts metadata XML of the service provider to ease configuraion, use this url to download metadata XML.

View file

@ -1,6 +1,8 @@
Authentication guide - Twitter
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. Sign-in or sign-up for a Twitter account
2. Go to the Twitter Application management page [here](https://apps.twitter.com/)
3. Click on the **Create New App** button to create a new Twitter app:

View file

@ -1,6 +1,8 @@
Minio Guide for HackMD
Minio Guide for CodiMD
===
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. First of all you need to setup Minio itself.
Please refer to the [official Minio docs](https://docs.minio.io/) for an

View file

@ -1,4 +1,6 @@
# Guide - Setup HackMD S3 image upload
# Guide - Setup CodiMD S3 image upload
***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!*
1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket.

View file

@ -41,7 +41,7 @@ module.exports = {
defaultNotePath: './public/default.md',
docsPath: './public/docs',
indexPath: './public/views/index.ejs',
hackmdPath: './public/views/hackmd.ejs',
codimdPath: './public/views/codimd.ejs',
errorPath: './public/views/error.ejs',
prettyPath: './public/views/pretty.ejs',
slidePath: './public/views/slide.ejs',

View file

@ -3,123 +3,123 @@
const {toBooleanConfig, toArrayConfig, toIntegerConfig} = require('./utils')
module.exports = {
domain: process.env.HMD_DOMAIN,
urlPath: process.env.HMD_URL_PATH,
port: toIntegerConfig(process.env.HMD_PORT),
urlAddPort: toBooleanConfig(process.env.HMD_URL_ADDPORT),
useSSL: toBooleanConfig(process.env.HMD_USESSL),
domain: process.env.CMD_DOMAIN,
urlPath: process.env.CMD_URL_PATH,
port: toIntegerConfig(process.env.CMD_PORT),
urlAddPort: toBooleanConfig(process.env.CMD_URL_ADDPORT),
useSSL: toBooleanConfig(process.env.CMD_USESSL),
hsts: {
enable: toBooleanConfig(process.env.HMD_HSTS_ENABLE),
maxAgeSeconds: process.env.HMD_HSTS_MAX_AGE,
includeSubdomains: toBooleanConfig(process.env.HMD_HSTS_INCLUDE_SUBDOMAINS),
preload: toBooleanConfig(process.env.HMD_HSTS_PRELOAD)
enable: toBooleanConfig(process.env.CMD_HSTS_ENABLE),
maxAgeSeconds: process.env.CMD_HSTS_MAX_AGE,
includeSubdomains: toBooleanConfig(process.env.CMD_HSTS_INCLUDE_SUBDOMAINS),
preload: toBooleanConfig(process.env.CMD_HSTS_PRELOAD)
},
csp: {
enable: toBooleanConfig(process.env.HMD_CSP_ENABLE),
reportURI: process.env.HMD_CSP_REPORTURI
enable: toBooleanConfig(process.env.CMD_CSP_ENABLE),
reportURI: process.env.CMD_CSP_REPORTURI
},
protocolUseSSL: toBooleanConfig(process.env.HMD_PROTOCOL_USESSL),
allowOrigin: toArrayConfig(process.env.HMD_ALLOW_ORIGIN),
useCDN: toBooleanConfig(process.env.HMD_USECDN),
allowAnonymous: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS),
allowAnonymousEdits: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS_EDITS),
allowFreeURL: toBooleanConfig(process.env.HMD_ALLOW_FREEURL),
defaultPermission: process.env.HMD_DEFAULT_PERMISSION,
dbURL: process.env.HMD_DB_URL,
sessionSecret: process.env.HMD_SESSION_SECRET,
sessionLife: toIntegerConfig(process.env.HMD_SESSION_LIFE),
imageUploadType: process.env.HMD_IMAGE_UPLOAD_TYPE,
protocolUseSSL: toBooleanConfig(process.env.CMD_PROTOCOL_USESSL),
allowOrigin: toArrayConfig(process.env.CMD_ALLOW_ORIGIN),
useCDN: toBooleanConfig(process.env.CMD_USECDN),
allowAnonymous: toBooleanConfig(process.env.CMD_ALLOW_ANONYMOUS),
allowAnonymousEdits: toBooleanConfig(process.env.CMD_ALLOW_ANONYMOUS_EDITS),
allowFreeURL: toBooleanConfig(process.env.CMD_ALLOW_FREEURL),
defaultPermission: process.env.CMD_DEFAULT_PERMISSION,
dbURL: process.env.CMD_DB_URL,
sessionSecret: process.env.CMD_SESSION_SECRET,
sessionLife: toIntegerConfig(process.env.CMD_SESSION_LIFE),
imageUploadType: process.env.CMD_IMAGE_UPLOAD_TYPE,
imgur: {
clientID: process.env.HMD_IMGUR_CLIENTID
clientID: process.env.CMD_IMGUR_CLIENTID
},
s3: {
accessKeyId: process.env.HMD_S3_ACCESS_KEY_ID,
secretAccessKey: process.env.HMD_S3_SECRET_ACCESS_KEY,
region: process.env.HMD_S3_REGION
accessKeyId: process.env.CMD_S3_ACCESS_KEY_ID,
secretAccessKey: process.env.CMD_S3_SECRET_ACCESS_KEY,
region: process.env.CMD_S3_REGION
},
minio: {
accessKey: process.env.HMD_MINIO_ACCESS_KEY,
secretKey: process.env.HMD_MINIO_SECRET_KEY,
endPoint: process.env.HMD_MINIO_ENDPOINT,
secure: toBooleanConfig(process.env.HMD_MINIO_SECURE),
port: toIntegerConfig(process.env.HMD_MINIO_PORT)
accessKey: process.env.CMD_MINIO_ACCESS_KEY,
secretKey: process.env.CMD_MINIO_SECRET_KEY,
endPoint: process.env.CMD_MINIO_ENDPOINT,
secure: toBooleanConfig(process.env.CMD_MINIO_SECURE),
port: toIntegerConfig(process.env.CMD_MINIO_PORT)
},
s3bucket: process.env.HMD_S3_BUCKET,
s3bucket: process.env.CMD_S3_BUCKET,
azure: {
connectionString: process.env.HMD_AZURE_CONNECTION_STRING,
container: process.env.HMD_AZURE_CONTAINER
connectionString: process.env.CMD_AZURE_CONNECTION_STRING,
container: process.env.CMD_AZURE_CONTAINER
},
facebook: {
clientID: process.env.HMD_FACEBOOK_CLIENTID,
clientSecret: process.env.HMD_FACEBOOK_CLIENTSECRET
clientID: process.env.CMD_FACEBOOK_CLIENTID,
clientSecret: process.env.CMD_FACEBOOK_CLIENTSECRET
},
twitter: {
consumerKey: process.env.HMD_TWITTER_CONSUMERKEY,
consumerSecret: process.env.HMD_TWITTER_CONSUMERSECRET
consumerKey: process.env.CMD_TWITTER_CONSUMERKEY,
consumerSecret: process.env.CMD_TWITTER_CONSUMERSECRET
},
github: {
clientID: process.env.HMD_GITHUB_CLIENTID,
clientSecret: process.env.HMD_GITHUB_CLIENTSECRET
clientID: process.env.CMD_GITHUB_CLIENTID,
clientSecret: process.env.CMD_GITHUB_CLIENTSECRET
},
gitlab: {
baseURL: process.env.HMD_GITLAB_BASEURL,
clientID: process.env.HMD_GITLAB_CLIENTID,
clientSecret: process.env.HMD_GITLAB_CLIENTSECRET,
scope: process.env.HMD_GITLAB_SCOPE
baseURL: process.env.CMD_GITLAB_BASEURL,
clientID: process.env.CMD_GITLAB_CLIENTID,
clientSecret: process.env.CMD_GITLAB_CLIENTSECRET,
scope: process.env.CMD_GITLAB_SCOPE
},
mattermost: {
baseURL: process.env.HMD_MATTERMOST_BASEURL,
clientID: process.env.HMD_MATTERMOST_CLIENTID,
clientSecret: process.env.HMD_MATTERMOST_CLIENTSECRET
baseURL: process.env.CMD_MATTERMOST_BASEURL,
clientID: process.env.CMD_MATTERMOST_CLIENTID,
clientSecret: process.env.CMD_MATTERMOST_CLIENTSECRET
},
oauth2: {
baseURL: process.env.HMD_OAUTH2_BASEURL,
userProfileURL: process.env.HMD_OAUTH2_USER_PROFILE_URL,
userProfileUsernameAttr: process.env.HMD_OAUTH2_USER_PROFILE_USERNAME_ATTR,
userProfileDisplayNameAttr: process.env.HMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR,
userProfileEmailAttr: process.env.HMD_OAUTH2_USER_PROFILE_EMAIL_ATTR,
tokenURL: process.env.HMD_OAUTH2_TOKEN_URL,
authorizationURL: process.env.HMD_OAUTH2_AUTHORIZATION_URL,
clientID: process.env.HMD_OAUTH2_CLIENT_ID,
clientSecret: process.env.HMD_OAUTH2_CLIENT_SECRET
baseURL: process.env.CMD_OAUTH2_BASEURL,
userProfileURL: process.env.CMD_OAUTH2_USER_PROFILE_URL,
userProfileUsernameAttr: process.env.CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR,
userProfileDisplayNameAttr: process.env.CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR,
userProfileEmailAttr: process.env.CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR,
tokenURL: process.env.CMD_OAUTH2_TOKEN_URL,
authorizationURL: process.env.CMD_OAUTH2_AUTHORIZATION_URL,
clientID: process.env.CMD_OAUTH2_CLIENT_ID,
clientSecret: process.env.CMD_OAUTH2_CLIENT_SECRET
},
dropbox: {
clientID: process.env.HMD_DROPBOX_CLIENTID,
clientSecret: process.env.HMD_DROPBOX_CLIENTSECRET,
appKey: process.env.HMD_DROPBOX_APPKEY
clientID: process.env.CMD_DROPBOX_CLIENTID,
clientSecret: process.env.CMD_DROPBOX_CLIENTSECRET,
appKey: process.env.CMD_DROPBOX_APPKEY
},
google: {
clientID: process.env.HMD_GOOGLE_CLIENTID,
clientSecret: process.env.HMD_GOOGLE_CLIENTSECRET
clientID: process.env.CMD_GOOGLE_CLIENTID,
clientSecret: process.env.CMD_GOOGLE_CLIENTSECRET
},
ldap: {
providerName: process.env.HMD_LDAP_PROVIDERNAME,
url: process.env.HMD_LDAP_URL,
bindDn: process.env.HMD_LDAP_BINDDN,
bindCredentials: process.env.HMD_LDAP_BINDCREDENTIALS,
searchBase: process.env.HMD_LDAP_SEARCHBASE,
searchFilter: process.env.HMD_LDAP_SEARCHFILTER,
searchAttributes: toArrayConfig(process.env.HMD_LDAP_SEARCHATTRIBUTES),
usernameField: process.env.HMD_LDAP_USERNAMEFIELD,
useridField: process.env.HMD_LDAP_USERIDFIELD,
tlsca: process.env.HMD_LDAP_TLS_CA
providerName: process.env.CMD_LDAP_PROVIDERNAME,
url: process.env.CMD_LDAP_URL,
bindDn: process.env.CMD_LDAP_BINDDN,
bindCredentials: process.env.CMD_LDAP_BINDCREDENTIALS,
searchBase: process.env.CMD_LDAP_SEARCHBASE,
searchFilter: process.env.CMD_LDAP_SEARCHFILTER,
searchAttributes: toArrayConfig(process.env.CMD_LDAP_SEARCHATTRIBUTES),
usernameField: process.env.CMD_LDAP_USERNAMEFIELD,
useridField: process.env.CMD_LDAP_USERIDFIELD,
tlsca: process.env.CMD_LDAP_TLS_CA
},
saml: {
idpSsoUrl: process.env.HMD_SAML_IDPSSOURL,
idpCert: process.env.HMD_SAML_IDPCERT,
issuer: process.env.HMD_SAML_ISSUER,
identifierFormat: process.env.HMD_SAML_IDENTIFIERFORMAT,
groupAttribute: process.env.HMD_SAML_GROUPATTRIBUTE,
externalGroups: toArrayConfig(process.env.HMD_SAML_EXTERNALGROUPS, '|', []),
requiredGroups: toArrayConfig(process.env.HMD_SAML_REQUIREDGROUPS, '|', []),
idpSsoUrl: process.env.CMD_SAML_IDPSSOURL,
idpCert: process.env.CMD_SAML_IDPCERT,
issuer: process.env.CMD_SAML_ISSUER,
identifierFormat: process.env.CMD_SAML_IDENTIFIERFORMAT,
groupAttribute: process.env.CMD_SAML_GROUPATTRIBUTE,
externalGroups: toArrayConfig(process.env.CMD_SAML_EXTERNALGROUPS, '|', []),
requiredGroups: toArrayConfig(process.env.CMD_SAML_REQUIREDGROUPS, '|', []),
attribute: {
id: process.env.HMD_SAML_ATTRIBUTE_ID,
username: process.env.HMD_SAML_ATTRIBUTE_USERNAME,
email: process.env.HMD_SAML_ATTRIBUTE_EMAIL
id: process.env.CMD_SAML_ATTRIBUTE_ID,
username: process.env.CMD_SAML_ATTRIBUTE_USERNAME,
email: process.env.CMD_SAML_ATTRIBUTE_EMAIL
}
},
email: toBooleanConfig(process.env.HMD_EMAIL),
allowEmailRegister: toBooleanConfig(process.env.HMD_ALLOW_EMAIL_REGISTER),
allowGravatar: toBooleanConfig(process.env.HMD_ALLOW_GRAVATAR),
allowPDFExport: toBooleanConfig(process.env.HMD_ALLOW_PDF_EXPORT)
email: toBooleanConfig(process.env.CMD_EMAIL),
allowEmailRegister: toBooleanConfig(process.env.CMD_ALLOW_EMAIL_REGISTER),
allowGravatar: toBooleanConfig(process.env.CMD_ALLOW_GRAVATAR),
allowPDFExport: toBooleanConfig(process.env.CMD_ALLOW_PDF_EXPORT)
}

View file

@ -0,0 +1,124 @@
'use strict'
const {toBooleanConfig, toArrayConfig, toIntegerConfig} = require('./utils')
module.exports = {
domain: process.env.HMD_DOMAIN,
urlPath: process.env.HMD_URL_PATH,
port: toIntegerConfig(process.env.HMD_PORT),
urlAddPort: toBooleanConfig(process.env.HMD_URL_ADDPORT),
useSSL: toBooleanConfig(process.env.HMD_USESSL),
hsts: {
enable: toBooleanConfig(process.env.HMD_HSTS_ENABLE),
maxAgeSeconds: process.env.HMD_HSTS_MAX_AGE,
includeSubdomains: toBooleanConfig(process.env.HMD_HSTS_INCLUDE_SUBDOMAINS),
preload: toBooleanConfig(process.env.HMD_HSTS_PRELOAD)
},
csp: {
enable: toBooleanConfig(process.env.HMD_CSP_ENABLE),
reportURI: process.env.HMD_CSP_REPORTURI
},
protocolUseSSL: toBooleanConfig(process.env.HMD_PROTOCOL_USESSL),
allowOrigin: toArrayConfig(process.env.HMD_ALLOW_ORIGIN),
useCDN: toBooleanConfig(process.env.HMD_USECDN),
allowAnonymous: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS),
allowAnonymousEdits: toBooleanConfig(process.env.HMD_ALLOW_ANONYMOUS_EDITS),
allowFreeURL: toBooleanConfig(process.env.HMD_ALLOW_FREEURL),
defaultPermission: process.env.HMD_DEFAULT_PERMISSION,
dbURL: process.env.HMD_DB_URL,
sessionSecret: process.env.HMD_SESSION_SECRET,
sessionLife: toIntegerConfig(process.env.HMD_SESSION_LIFE),
imageUploadType: process.env.HMD_IMAGE_UPLOAD_TYPE,
imgur: {
clientID: process.env.HMD_IMGUR_CLIENTID
},
s3: {
accessKeyId: process.env.HMD_S3_ACCESS_KEY_ID,
secretAccessKey: process.env.HMD_S3_SECRET_ACCESS_KEY,
region: process.env.HMD_S3_REGION
},
minio: {
accessKey: process.env.HMD_MINIO_ACCESS_KEY,
secretKey: process.env.HMD_MINIO_SECRET_KEY,
endPoint: process.env.HMD_MINIO_ENDPOINT,
secure: toBooleanConfig(process.env.HMD_MINIO_SECURE),
port: toIntegerConfig(process.env.HMD_MINIO_PORT)
},
s3bucket: process.env.HMD_S3_BUCKET,
azure: {
connectionString: process.env.HMD_AZURE_CONNECTION_STRING,
container: process.env.HMD_AZURE_CONTAINER
},
facebook: {
clientID: process.env.HMD_FACEBOOK_CLIENTID,
clientSecret: process.env.HMD_FACEBOOK_CLIENTSECRET
},
twitter: {
consumerKey: process.env.HMD_TWITTER_CONSUMERKEY,
consumerSecret: process.env.HMD_TWITTER_CONSUMERSECRET
},
github: {
clientID: process.env.HMD_GITHUB_CLIENTID,
clientSecret: process.env.HMD_GITHUB_CLIENTSECRET
},
gitlab: {
baseURL: process.env.HMD_GITLAB_BASEURL,
clientID: process.env.HMD_GITLAB_CLIENTID,
clientSecret: process.env.HMD_GITLAB_CLIENTSECRET,
scope: process.env.HMD_GITLAB_SCOPE
},
mattermost: {
baseURL: process.env.HMD_MATTERMOST_BASEURL,
clientID: process.env.HMD_MATTERMOST_CLIENTID,
clientSecret: process.env.HMD_MATTERMOST_CLIENTSECRET
},
oauth2: {
baseURL: process.env.HMD_OAUTH2_BASEURL,
userProfileURL: process.env.HMD_OAUTH2_USER_PROFILE_URL,
userProfileUsernameAttr: process.env.HMD_OAUTH2_USER_PROFILE_USERNAME_ATTR,
userProfileDisplayNameAttr: process.env.HMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR,
userProfileEmailAttr: process.env.HMD_OAUTH2_USER_PROFILE_EMAIL_ATTR,
tokenURL: process.env.HMD_OAUTH2_TOKEN_URL,
authorizationURL: process.env.HMD_OAUTH2_AUTHORIZATION_URL,
clientID: process.env.HMD_OAUTH2_CLIENT_ID,
clientSecret: process.env.HMD_OAUTH2_CLIENT_SECRET
},
dropbox: {
clientID: process.env.HMD_DROPBOX_CLIENTID,
clientSecret: process.env.HMD_DROPBOX_CLIENTSECRET,
appKey: process.env.HMD_DROPBOX_APPKEY
},
google: {
clientID: process.env.HMD_GOOGLE_CLIENTID,
clientSecret: process.env.HMD_GOOGLE_CLIENTSECRET
},
ldap: {
providerName: process.env.HMD_LDAP_PROVIDERNAME,
url: process.env.HMD_LDAP_URL,
bindDn: process.env.HMD_LDAP_BINDDN,
bindCredentials: process.env.HMD_LDAP_BINDCREDENTIALS,
searchBase: process.env.HMD_LDAP_SEARCHBASE,
searchFilter: process.env.HMD_LDAP_SEARCHFILTER,
searchAttributes: toArrayConfig(process.env.HMD_LDAP_SEARCHATTRIBUTES),
usernameField: process.env.HMD_LDAP_USERNAMEFIELD,
useridField: process.env.HMD_LDAP_USERIDFIELD,
tlsca: process.env.HMD_LDAP_TLS_CA
},
saml: {
idpSsoUrl: process.env.HMD_SAML_IDPSSOURL,
idpCert: process.env.HMD_SAML_IDPCERT,
issuer: process.env.HMD_SAML_ISSUER,
identifierFormat: process.env.HMD_SAML_IDENTIFIERFORMAT,
groupAttribute: process.env.HMD_SAML_GROUPATTRIBUTE,
externalGroups: toArrayConfig(process.env.HMD_SAML_EXTERNALGROUPS, '|', []),
requiredGroups: toArrayConfig(process.env.HMD_SAML_REQUIREDGROUPS, '|', []),
attribute: {
id: process.env.HMD_SAML_ATTRIBUTE_ID,
username: process.env.HMD_SAML_ATTRIBUTE_USERNAME,
email: process.env.HMD_SAML_ATTRIBUTE_EMAIL
}
},
email: toBooleanConfig(process.env.HMD_EMAIL),
allowEmailRegister: toBooleanConfig(process.env.HMD_ALLOW_EMAIL_REGISTER),
allowPDFExport: toBooleanConfig(process.env.HMD_ALLOW_PDF_EXPORT)
}

View file

@ -33,6 +33,7 @@ merge(config, debugConfig)
merge(config, packageConfig)
merge(config, fileConfig)
merge(config, require('./oldEnvironment'))
merge(config, require('./hackmdEnvironment'))
merge(config, require('./environment'))
merge(config, require('./dockerSecret'))
@ -122,6 +123,11 @@ for (let i = keys.length; i--;) {
}
}
// Notify users about the prefix change and inform them they use legacy prefix for environment variables
if (Object.keys(process.env).toString().indexOf('HMD_') !== -1) {
logger.warn('Using legacy HMD prefix for environment variables. Please change your variables in future. For details see: https://github.com/hackmdio/codimd#environment-variables-will-overwrite-other-server-configs')
}
// Generate session secret if it stays on default values
if (config.sessionSecret === 'secret') {
logger.warn('Session secret not set. Using random generated one. Please set `sessionSecret` in your config.js file. All users will be logged out.')
@ -169,7 +175,7 @@ config.tmpPath = path.join(appRootPath, config.tmpPath)
config.defaultNotePath = path.join(appRootPath, config.defaultNotePath)
config.docsPath = path.join(appRootPath, config.docsPath)
config.indexPath = path.join(appRootPath, config.indexPath)
config.hackmdPath = path.join(appRootPath, config.hackmdPath)
config.codimdPath = path.join(appRootPath, config.codimdPath)
config.errorPath = path.join(appRootPath, config.errorPath)
config.prettyPath = path.join(appRootPath, config.prettyPath)
config.slidePath = path.join(appRootPath, config.slidePath)

View file

@ -6,7 +6,7 @@ var CspStrategy = {}
var defaultDirectives = {
defaultSrc: ['\'self\''],
scriptSrc: ['\'self\'', 'vimeo.com', 'https://gist.github.com', 'www.slideshare.net', 'https://query.yahooapis.com', '\'unsafe-eval\''],
// ^ TODO: Remove unsafe-eval - webpack script-loader issues https://github.com/hackmdio/hackmd/issues/594
// ^ TODO: Remove unsafe-eval - webpack script-loader issues https://github.com/hackmdio/codimd/issues/594
imgSrc: ['*'],
styleSrc: ['\'self\'', '\'unsafe-inline\'', 'https://assets-cdn.github.com'], // unsafe-inline is required for some libs, plus used in views
fontSrc: ['\'self\'', 'https://public.slidesharecdn.com'],

View file

@ -301,7 +301,7 @@ module.exports = function (sequelize, DataTypes) {
return title || 'Untitled'
},
generateWebTitle: function (title) {
title = !title || title === 'Untitled' ? 'HackMD - Collaborative markdown notes' : title + ' - HackMD'
title = !title || title === 'Untitled' ? 'CodiMD - Collaborative markdown notes' : title + ' - CodiMD'
return title
},
extractNoteTags: function (meta, $) {

View file

@ -109,7 +109,7 @@ function showIndex (req, res, next) {
}
}
function responseHackMD (res, note) {
function responseCodiMD (res, note) {
var body = note.content
var extracted = models.Note.extractMeta(body)
var meta = models.Note.parseMeta(extracted.meta)
@ -119,7 +119,7 @@ function responseHackMD (res, note) {
'Cache-Control': 'private', // only cache by client
'X-Robots-Tag': 'noindex, nofollow' // prevent crawling
})
res.render(config.hackmdPath, {
res.render(config.codimdPath, {
url: config.serverURL,
title: title,
useCDN: config.useCDN,
@ -214,7 +214,7 @@ function showNote (req, res, next) {
var noteId = req.params.noteId
var id = models.Note.encodeNoteId(note.id)
if ((note.alias && noteId !== note.alias) || (!note.alias && noteId !== id)) { return res.redirect(config.serverURL + '/' + (note.alias || id)) }
return responseHackMD(res, note)
return responseCodiMD(res, note)
})
}
@ -527,7 +527,7 @@ function githubActionGist (req, res, note) {
request({
url: gistUrl,
headers: {
'User-Agent': 'HackMD',
'User-Agent': 'CodiMD',
'Authorization': 'token ' + accessToken
},
method: 'POST',

View file

@ -0,0 +1,10 @@
'use strict'
const config = require('../../config')
module.exports = function (req, res, next) {
res.set({
'CodiMD-Version': config.version
})
return next()
}

View file

@ -17,8 +17,7 @@ statusRouter.get('/status', function (req, res, next) {
realtime.getStatus(function (data) {
res.set({
'Cache-Control': 'private', // only cache by client
'X-Robots-Tag': 'noindex, nofollow', // prevent crawling
'HackMD-Version': config.version
'X-Robots-Tag': 'noindex, nofollow' // prevent crawling
})
res.send(data)
})
@ -102,8 +101,7 @@ statusRouter.get('/config', function (req, res) {
}
res.set({
'Cache-Control': 'private', // only cache by client
'X-Robots-Tag': 'noindex, nofollow', // prevent crawling
'HackMD-Version': config.version
'X-Robots-Tag': 'noindex, nofollow' // prevent crawling
})
res.render(config.constantsPath, data)
})

View file

@ -1,5 +1,5 @@
{
"name": "hackmd",
"name": "CodiMD",
"version": "1.1.1-ce",
"description": "Realtime collaborative markdown notes on all platforms.",
"main": "app.js",
@ -136,7 +136,7 @@
"engines": {
"node": ">=6.x <10.x"
},
"bugs": "https://github.com/hackmdio/hackmd/issues",
"bugs": "https://github.com/hackmdio/codimd/issues",
"keywords": [
"Collaborative",
"Markdown",
@ -151,7 +151,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/hackmdio/hackmd.git"
"url": "https://github.com/hackmdio/codimd.git"
},
"devDependencies": {
"babel-cli": "^6.18.0",

View file

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View file

@ -3,12 +3,12 @@ Features
Introduction
===
<i class="fa fa-file-text"></i> **HackMD** is a realtime, multi-platform collaborative markdown note editor.
<i class="fa fa-file-text"></i> **CodiMD** is a real-time, multi-platform collaborative markdown note editor.
This means that you can write notes with other people on your **desktop**, **tablet** or even on the **phone**.
You can sign-in via multiple auth providers like **Facebook**, **Twitter**, **GitHub** and many more on the [_homepage_](/).
If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/hackmdio/hackmd/issues).
Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#hackmd:matrix.org) or [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help.
If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/hackmdio/codimd/issues).
Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#codimd:matrix.org) or [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help.
**Thank you very much!**
Workspace
@ -26,7 +26,7 @@ Workspace
<i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor.
## Night Mode:
When you are tired of a white screen and like a night mode, click on the little moon <i class="fa fa-moon-o"></i> and turn on the night view of HackMD.
When you are tired of a white screen and like a night mode, click on the little moon <i class="fa fa-moon-o"></i> and turn on the night view of CodiMD.
The editor view, which is in night mode by default, can also be toggled between night and day view using the the little sun<i class="fa fa-sun-o fa-fw"></i>.

View file

@ -6,9 +6,9 @@ We process the following data, for the following purposes:
|your data|our usage|
|---------|---------|
|IP-Address|Used to communicate with your browser and our servers. It's may exposed to third-parties which provide resources for this service. These services are, depending on your login method, the document you visit and the setup of this instance: Google, Disqus, MathJax, GitHub, SlideShare/LinkedIn, yahoo, Gravatar, Imgur, Amazon, and Cloudflare.|
|Usernames and profiles|Your username as well as user profiles that are connected with it are transmitted and stored by us to provide a useful login integration with services like GitHub, Facebook, Twitter, GitLab, Dropbox, Google. Depending on the setup of this HackMD instance there are maybe other third-parties involved using SAML, LDAP or the integration with a Mattermost instance.|
|Profile pictures| Your profile picture is either loaded from the service you used to login, the HackMD instance or Gravatar.|
|Uploaded pictures| Pictures that are uploaded for documents are either uploaded to Amazon S3, Imgur, a minio instance or the local filesystem of the HackMD server.|
|Usernames and profiles|Your username as well as user profiles that are connected with it are transmitted and stored by us to provide a useful login integration with services like GitHub, Facebook, Twitter, GitLab, Dropbox, Google. Depending on the setup of this CodiMD instance there are maybe other third-parties involved using SAML, LDAP or the integration with a Mattermost instance.|
|Profile pictures| Your profile picture is either loaded from the service you used to login, the CodiMD instance or Gravatar.|
|Uploaded pictures| Pictures that are uploaded for documents are either uploaded to Amazon S3, Imgur, a minio instance or the local filesystem of the CodiMD server.|
All account data and notes are stored in a mysql/postgres/sqlite database. Besides the user accounts and the document themselves also relationships between the documents and the user accounts are stored. This includes ownership, authorship and revisions of all changes made during the creation of a note.

View file

@ -96,7 +96,7 @@ dir: rtl
breaks
---
This option means the hardbreaks in the note will be parsed or be ignore.
The original markdown syntax breaks only if you put space twice, but HackMD choose to breaks every time you enter a break.
The original markdown syntax breaks only if you put space twice, but CodiMD choose to breaks every time you enter a break.
You can only use whether `true` or `false`.
> default: not set (which will be true)
@ -125,7 +125,7 @@ This option allow you to enable Disqus with your shortname.
**Example**
```xml
disqus: hackmd
disqus: codimd
```
slideOptions

View file

@ -318,7 +318,7 @@ $('.ui-save-history').click(() => {
const blob = new Blob([history], {
type: 'application/json;charset=utf-8'
})
saveAs(blob, `hackmd_history_${moment().format('YYYYMMDDHHmmss')}`, true)
saveAs(blob, `codimd_history_${moment().format('YYYYMMDDHHmmss')}`, true)
})
})

View file

@ -105,9 +105,9 @@ function getTitle (view) {
export function renderTitle (view) {
let title = getTitle(view)
if (title) {
title += ' - HackMD'
title += ' - CodiMD'
} else {
title = 'HackMD - Collaborative markdown notes'
title = 'CodiMD - Collaborative markdown notes'
}
return title
}

15
public/views/codimd.ejs Normal file
View file

@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<%- include codimd/head %>
</head>
<body>
<%- include codimd/header %>
<%- include codimd/body %>
<%- include codimd/footer %>
<%- include codimd/foot %>
</body>
</html>

View file

@ -13,7 +13,7 @@
<ul class="dropdown-menu list" role="menu" aria-labelledby="menu">
</ul>
</div>
<a class="navbar-brand pull-left" href="<%- url %>/"><i class="fa fa-file-text"></i> HackMD</a>
<a class="navbar-brand pull-left" href="<%- url %>/"><i class="fa fa-file-text"></i> CodiMD</a>
<div class="nav-mobile pull-right visible-xs">
<span class="btn btn-link btn-file ui-upload-image" title="Upload Image" style="display:none;">
<i class="fa fa-camera"></i><input type="file" accept="image/*" name="upload" multiple>

View file

@ -2,18 +2,18 @@
<html lang="en">
<head>
<%- include hackmd/head %>
<%- include codimd/head %>
<link rel="stylesheet" href="<%- url %>/css/center.css">
</head>
<body>
<%- include hackmd/header %>
<%- include codimd/header %>
<div class="container-fluid text-center">
<div class="vertical-center-row">
<h1><%- code %> <%- detail %> <small><%- msg %></small></h1>
</div>
</div>
<%- include hackmd/footer %>
<%- include codimd/footer %>
</body>
</html>

View file

@ -1,15 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<%- include hackmd/head %>
</head>
<body>
<%- include hackmd/header %>
<%- include hackmd/body %>
<%- include hackmd/footer %>
<%- include hackmd/foot %>
</body>
</html>

View file

@ -40,8 +40,7 @@
<div id="home" class="section"<% if(signin) { %> style="display:none;"<% } %>>
<div class="inner cover">
<h1 class="cover-heading"><i class="fa fa-file-text"></i> HackMD</h1>
<p class="lead"><strong>Community Edition</strong></p>
<h1 class="cover-heading"><i class="fa fa-file-text"></i> CodiMD</h1>
<p class="lead">
<%= __('Best way to write and share your knowledge in markdown.') %>
</p>
@ -150,10 +149,10 @@
<option value="ko">한국어</option>
</select>
<p>
&copy; 2018 <a href="https://hackmd.io">HackMD</a> | <a href="<%- url %>/s/release-notes" target="_blank"><%= __('Releases') %></a><% if(privacyStatement) { %> | <a href="<%- url %>/s/privacy" target="_blank"><%= __('Privacy') %></a><% } %><% if(termsOfUse) { %> | <a href="<%- url %>/s/terms-of-use" target="_blank"><%= __('Terms of Use') %></a><% } %>
&copy; 2018 <a href="https://hackmd.io">CodiMD</a> | <a href="<%- url %>/s/release-notes" target="_blank"><%= __('Releases') %></a><% if(privacyStatement) { %> | <a href="<%- url %>/s/privacy" target="_blank"><%= __('Privacy') %></a><% } %><% if(termsOfUse) { %> | <a href="<%- url %>/s/terms-of-use" target="_blank"><%= __('Terms of Use') %></a><% } %>
</p>
<h6 class="social-foot">
<%- __('Follow us on %s and %s.', '<a href="https://github.com/hackmdio/HackMD" target="_blank"><i class="fa fa-github"></i> GitHub</a>, <a href="https://twitter.com/hackmdio" target="_blank"><i class="fa fa-twitter"></i> Twitter</a>', '<a href="https://www.facebook.com/hackmdio" target="_blank"><i class="fa fa-facebook-square"></i> Facebook</a>') %>
<%- __('Follow us on %s and %s.', '<a href="https://github.com/hackmdio/CodiMD" target="_blank"><i class="fa fa-github"></i> GitHub</a>, <a href="https://twitter.com/hackmdio" target="_blank"><i class="fa fa-twitter"></i> Twitter</a>', '<a href="https://www.facebook.com/hackmdio" target="_blank"><i class="fa fa-facebook-square"></i> Facebook</a>') %>
</h6>
</div>
</div>

View file

@ -6,7 +6,7 @@
<meta name="mobile-web-app-capable" content="yes">
<meta name="description" content="<%= __('Best way to write and share your knowledge in markdown.') %>">
<meta name="keywords" content="Collaborative, Markdown, Notes">
<title>HackMD - <%= __('Collaborative markdown notes') %></title>
<title>CodiMD - <%= __('Collaborative markdown notes') %></title>
<link rel="icon" type="image/png" href="<%- url %>/favicon.png">
<link rel="apple-touch-icon" href="<%- url %>/apple-touch-icon.png">
<% if(useCDN) { %>

View file

@ -15,9 +15,9 @@
<h3 class="panel-title"><%= __('Contacts') %></h3>
</div>
<div class="panel-body">
<a href="https://github.com/hackmdio/hackmd/issues" target="_blank"><i class="fa fa-tag fa-fw"></i> <%= __('Report an issue') %></a>
<a href="https://github.com/hackmdio/codimd/issues" target="_blank"><i class="fa fa-tag fa-fw"></i> <%= __('Report an issue') %></a>
<br>
<a href="https://riot.im/app/#/room/#hackmd:matrix.org" target="_blank"><i class="fa fa-hashtag fa-fw"></i> <%= __('Meet us on %s', 'Matrix') %></a>
<a href="https://riot.im/app/#/room/#codimd:matrix.org" target="_blank"><i class="fa fa-hashtag fa-fw"></i> <%= __('Meet us on %s', 'Matrix') %></a>
<br>
<a href="https://gitter.im/hackmdio/hackmd" target="_blank"><i class="fa fa-comments fa-fw"></i> <%= __('Meet us on %s', 'Gitter') %></a>
</div>