mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-09-19 23:48:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
HedgeDoc - Ideas grow better together
164 commits 36 branches 47 tags 158 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Philip Molares 4852727f92
added support for markdown-it-abbr (#238) 
this makes it possible to use abbreviations like these
```
*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium
The HTML specification
is maintained by the W3C.
```

Co-authored-by: Philip Molares <philip@mauricedoepke.de>
2020-06-20 19:29:46 +02:00
.github Add pull request template (#208) 2020-06-15 21:07:16 +02:00
.idea/dictionaries Add codimd to jetbrains dictionary (#235) 2020-06-20 16:47:30 +02:00
icon Replace react icon with default codimd icon 2020-05-31 19:17:24 +02:00
public Adds an info banner to the app (#190) 2020-06-15 21:54:20 +02:00
src added support for markdown-it-abbr (#238) 2020-06-20 19:29:46 +02:00
.editorconfig better linting (#72) 2020-05-27 15:43:28 +02:00
.gitignore imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
CHANGELOG.md Add twemoji to changelog 2020-06-20 19:20:51 +02:00
LICENSE Add AGPL 3.0 2020-05-26 17:19:37 +02:00
package.json added support for markdown-it-abbr (#238) 2020-06-20 19:29:46 +02:00
README.md Add examples and cd command to README (#166) 2020-06-06 23:58:45 +02:00
renovate.json Updated schedule of renovate (#192) 2020-06-11 20:57:41 +02:00
tsconfig.json imported current state of the mockup into the public repo 2020-05-14 15:41:38 +02:00
yarn.lock added support for markdown-it-abbr (#238) 2020-06-20 19:29:46 +02:00

README.md

CodiMD - React Client

This is the new, improved and better looking frontend for CodiMD 2.0. Our goal is to recreate the current frontend in react and to improve it.

Preparation

You'll need at least Node 10 (we recommend 12). We use yarn for our dependencies, but npm can work too.

Development mode

  1. Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
  2. Go inside the repo (e.g. cd codimd-react-client)
  3. run yarn install
  4. run yarn start

This should run the app in the development mode and open http://localhost:3000 in your browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Production mode

  1. Clone this repo (e.g. git clone https://github.com/codimd/react-client.git codimd-react-client)
  2. Go inside the repo (e.g. cd codimd-react-client)
  3. run yarn install
  4. run yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.