depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Rebrand HackMD to CodiMD

Browse source 
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
This commit is contained in:
Sheogorath 2018-06-22 21:07:30 +02:00
parent d87505d583
commit 4b060c7dba
No known key found for this signature in database
GPG key ID: 1F05CC3635CDDFFD
16 changed files with 80 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -56,7 +56,7 @@ version 1.2.0, available at
### Sign your work ### Sign your work
We use the Developer Certificate of Origin (DCO) as a additional safeguard 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 mechanism to assure contributors have confirmed their right to license
their contribution under the project's license. their contribution under the project's license.
Please read [contribute/developer-certificate-of-origin][dcofile]. Please read [contribute/developer-certificate-of-origin][dcofile].

66
README.md
View file

@ -1,18 +1,18 @@
HackMD Community Edition CodiMD
=== ===
[![Standard - JavaScript Style Guide][standardjs-image]][standardjs-url] [![Standard - JavaScript Style Guide][standardjs-image]][standardjs-url]
[![Join the chat at https://gitter.im/hackmdio/hackmd][gitter-image]][gitter-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] [![build status][travis-image]][travis-url]
[![version][github-version-badge]][github-release-page] [![version][github-version-badge]][github-release-page]
[![Help Contribute to Open Source][codetriage-image]][codetriage-url] [![Help Contribute to Open Source][codetriage-image]][codetriage-url]
[![POEditor][poeditor-image]][poeditor-url] [![POEditor][poeditor-image]][poeditor-url]
HackMD lets you create realtime collaborative markdown notes on all platforms. CodiMD lets you create real-time collaborative markdown notes on all platforms.
Inspired by Hackpad, with more focus on speed and flexibility. Inspired by Hackpad, with more focus on speed and flexibility, and build from [HackMD](https://hackmd.io) source code.
Still in the early stage, feel free to fork or contribute to HackMD. Feel free to contribute.
Thanks for using! :smile: Thanks for using! :smile:
@ -27,7 +27,7 @@ Thanks for using! :smile:
- [Instructions](#instructions) - [Instructions](#instructions)
- [Heroku Deployment](#heroku-deployment) - [Heroku Deployment](#heroku-deployment)
- [Kubernetes](#kubernetes) - [Kubernetes](#kubernetes)
- [HackMD by docker container](#hackmd-by-docker-container) - [CodiMD by docker container](#codimd-by-docker-container)
- [Upgrade](#upgrade) - [Upgrade](#upgrade)
- [Native setup](#native-setup) - [Native setup](#native-setup)
- [Configuration](#configuration) - [Configuration](#configuration)
@ -60,7 +60,7 @@ Thanks for using! :smile:
- Node.js 6.x or up (test up to 7.5.0) - Node.js 6.x or up (test up to 7.5.0)
- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL) use charset `utf8` - 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)) - 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 ### Instructions
@ -73,9 +73,9 @@ Thanks for using! :smile:
## Heroku Deployment ## 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`. If you deploy it without the button, keep in mind to use the right buildpacks. For details check `app.json`.
@ -83,10 +83,10 @@ If you deploy it without the button, keep in mind to use the right buildpacks. F
To install use `helm install stable/hackmd`. 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 ## 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=hackmd) [![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:** **Debian-based version:**
@ -98,11 +98,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") [![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 ```console
git clone https://github.com/hackmdio/docker-hackmd.git git clone https://github.com/hackmdio/docker-hackmd.git
cd docker-hackmd cd docker-codimd
docker-compose up docker-compose up
``` ```
Read more about it in the [docker repository…](https://github.com/hackmdio/docker-hackmd) Read more about it in the [docker repository…](https://github.com/hackmdio/docker-hackmd)
@ -111,14 +111,14 @@ Read more about it in the [docker repository…](https://github.com/hackmdio/doc
## Native setup ## 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) 1. Fully stop your old server first (important)
2. `git pull` or do whatever that updates the files 2. `git pull` or do whatever that updates the files
3. `npm install` to update dependencies 3. `npm install` to update dependencies
4. Build front-end bundle by `npm run build` (use `npm run dev` if you are in development) 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 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 6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema
7. Start your whole new server! 7. Start your whole new server!
@ -154,10 +154,10 @@ 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`) | | `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 | | `DEBUG` | `true` or `false` | set debug mode; show more logs |
| `HMD_DOMAIN` | `hackmd.io` | domain name | | `HMD_DOMAIN` | `codimd.org` | domain name |
| `HMD_URL_PATH` | `hackmd` | sub URL path, like `www.example.com/<URL_PATH>` | | `HMD_URL_PATH` | `codimd` | sub URL path, like `www.example.com/<URL_PATH>` |
| `HMD_PORT` | `80` | web app port | | `HMD_PORT` | `80` | web app port |
| `HMD_ALLOW_ORIGIN` | `localhost, hackmd.io` | domain name whitelist (use comma to separate) | | `HMD_ALLOW_ORIGIN` | `localhost, codimd.org` | 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_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_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_USECDN` | `true` or `false` | set to use CDN resources or not (default is `true`) |
@ -191,8 +191,8 @@ There are some config settings you need to change in the files below.
| `HMD_LDAP_SEARCHBASE` | `o=users,dc=example,dc=com` | LDAP directory to begin search from | | `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_SEARCHFILTER` | `(uid={{username}})` | LDAP filter to search with |
| `HMD_LDAP_SEARCHATTRIBUTES` | `displayName, mail` | LDAP attributes to search with (use comma to separate) | | `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_USERIDFIELD` | `uidNumber` or `uid` or `sAMAccountName` | The LDAP field which is used uniquely identify a user on CodiMD |
| `HMD_LDAP_USERNAMEFIELD` | Fallback to userid | The LDAP field which is used as the username on HackMD | | `HMD_LDAP_USERNAMEFIELD` | Fallback to userid | The LDAP field which is used as the username on CodiMD |
| `HMD_LDAP_TLS_CA` | `server-cert.pem, root.pem` | Root CA for LDAP TLS in PEM format (use comma to separate) | | `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_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_IDPSSOURL` | `https://idp.example.com/sso` | authentication endpoint of IdP. for details, see [guide](docs/guides/auth.md#saml-onelogin). |
@ -235,7 +235,7 @@ There are some config settings you need to change in the files below.
| --------- | ------ | ----------- | | --------- | ------ | ----------- |
| `debug` | `true` or `false` | set debug mode, show more logs | | `debug` | `true` or `false` | set debug mode, show more logs |
| `domain` | `localhost` | domain name | | `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 | | `port` | `80` | web app port |
| `allowOrigin` | `['localhost']` | domain name whitelist | | `allowOrigin` | `['localhost']` | domain name whitelist |
| `useSSL` | `true` or `false` | set to use SSL server (if `true`, will auto turn on `protocolUseSSL`) | | `useSSL` | `true` or `false` | set to use SSL server (if `true`, will auto turn on `protocolUseSSL`) |
@ -249,9 +249,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 | | `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) | | `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 | | `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`) | | `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`) | | `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`) | | `dhParamPath` | `./cert/dhparam.pem` | SSL dhparam path (only need when you set `useSSL`) |
| `tmpPath` | `./tmp/` | temp directory path | | `tmpPath` | `./tmp/` | temp directory path |
@ -304,7 +304,7 @@ There are some config settings you need to change in the files below.
## Structure ## Structure
```text ```text
hackmd/ codimd/
├── tmp/ --- temporary files ├── tmp/ --- temporary files
├── docs/ --- document files ├── docs/ --- document files
├── lib/ --- server libraries ├── lib/ --- server libraries
@ -330,15 +330,15 @@ See more at [http://operational-transformation.github.io/](http://operational-tr
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg [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 [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-image]: https://img.shields.io/badge/Matrix.org-%23CodiMD@matrix.org-green.svg
[matrix.org-url]: https://riot.im/app/#/room/#hackmd:matrix.org [matrix.org-url]: https://riot.im/app/#/room/#codimd:matrix.org
[travis-image]: https://travis-ci.org/hackmdio/hackmd.svg?branch=master [travis-image]: https://travis-ci.org/hackmdio/codimd.svg?branch=master
[travis-url]: https://travis-ci.org/hackmdio/hackmd [travis-url]: https://travis-ci.org/hackmdio/codimd
[github-version-badge]: https://img.shields.io/github/release/hackmdio/hackmd.svg [github-version-badge]: https://img.shields.io/github/release/hackmdio/codimd.svg
[github-release-page]: https://github.com/hackmdio/hackmd/releases [github-release-page]: https://github.com/hackmdio/codimd/releases
[standardjs-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg [standardjs-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standardjs-url]: https://github.com/feross/standard [standardjs-url]: https://github.com/feross/standard
[codetriage-image]: https://www.codetriage.com/hackmdio/hackmd/badges/users.svg [codetriage-image]: https://www.codetriage.com/hackmdio/codimd/badges/users.svg
[codetriage-url]: https://www.codetriage.com/hackmdio/hackmd [codetriage-url]: https://www.codetriage.com/hackmdio/codimd
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg [poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir [poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir

2
app.js
View file

@ -234,7 +234,7 @@ process.on('uncaughtException', function (err) {
// install exit handler // install exit handler
function handleTermSignals () { 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 realtime.maintenance = true
// disconnect all socket.io clients // disconnect all socket.io clients
Object.keys(io.sockets.sockets).forEach(function (key) { Object.keys(io.sockets.sockets).forEach(function (key) {

6
app.json
View file

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

7
bin/setup
View file

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

4
config.json.example
View file

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

2
lib/models/note.js
View file

@ -301,7 +301,7 @@ module.exports = function (sequelize, DataTypes) {
return title || 'Untitled' return title || 'Untitled'
}, },
generateWebTitle: function (title) { 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 return title
}, },
extractNoteTags: function (meta, $) { extractNoteTags: function (meta, $) {

6
package.json
View file

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

0
public/hackmd-icon-1024.png → public/codimd-icon-1024.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

8
public/docs/features.md
View file

@ -3,12 +3,12 @@ Features
Introduction 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**. 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_](/). 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). 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/#hackmd:matrix.org) or [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help. 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!** **Thank you very much!**
Workspace Workspace
@ -26,7 +26,7 @@ Workspace
<i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor. <i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor.
## Night Mode: ## 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>. 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>.

4
public/docs/yaml-metadata.md
View file

@ -96,7 +96,7 @@ dir: rtl
breaks breaks
--- ---
This option means the hardbreaks in the note will be parsed or be ignore. 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`. You can only use whether `true` or `false`.
> default: not set (which will be true) > default: not set (which will be true)
@ -125,7 +125,7 @@ This option allow you to enable Disqus with your shortname.
**Example** **Example**
```xml ```xml
disqus: hackmd disqus: codimd
``` ```
slideOptions slideOptions

4
public/js/extra.js
View file

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

2
public/views/hackmd/header.ejs
View file

@ -13,7 +13,7 @@
<ul class="dropdown-menu list" role="menu" aria-labelledby="menu"> <ul class="dropdown-menu list" role="menu" aria-labelledby="menu">
</ul> </ul>
</div> </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"> <div class="nav-mobile pull-right visible-xs">
<span class="btn btn-link btn-file ui-upload-image" title="Upload Image" style="display:none;"> <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> <i class="fa fa-camera"></i><input type="file" accept="image/*" name="upload" multiple>

7
public/views/index/body.ejs
View file

@ -40,8 +40,7 @@
<div id="home" class="section"<% if(signin) { %> style="display:none;"<% } %>> <div id="home" class="section"<% if(signin) { %> style="display:none;"<% } %>>
<div class="inner cover"> <div class="inner cover">
<h1 class="cover-heading"><i class="fa fa-file-text"></i> HackMD</h1> <h1 class="cover-heading"><i class="fa fa-file-text"></i> CodiMD</h1>
<p class="lead"><strong>Community Edition</strong></p>
<p class="lead"> <p class="lead">
<%= __('Best way to write and share your knowledge in markdown.') %> <%= __('Best way to write and share your knowledge in markdown.') %>
</p> </p>
@ -150,10 +149,10 @@
<option value="ko">한국어</option> <option value="ko">한국어</option>
</select> </select>
<p> <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> </p>
<h6 class="social-foot"> <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> </h6>
</div> </div>
</div> </div>

2
public/views/index/head.ejs
View file

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

4
public/views/shared/help-modal.ejs
View file

@ -15,9 +15,9 @@
<h3 class="panel-title"><%= __('Contacts') %></h3> <h3 class="panel-title"><%= __('Contacts') %></h3>
</div> </div>
<div class="panel-body"> <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> <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> <br>
<a href="https://gitter.im/hackmdio/hackmd" target="_blank"><i class="fa fa-comments fa-fw"></i> <%= __('Meet us on %s', 'Gitter') %></a> <a href="https://gitter.im/hackmdio/hackmd" target="_blank"><i class="fa fa-comments fa-fw"></i> <%= __('Meet us on %s', 'Gitter') %></a>
</div> </div>