github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-23 23:31:04 +00:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
171 commits 39 branches 47 tags 112 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Erik Michelson fd378cf89b
Added TOC and anchors for headings (#243) 
* Added TOC support and anchors for headings

* Moved @types/markdown-it-anchor from devDependencies to dependencies

* Add subnode renderer

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

* Added node-replacer for toc generation

ul lists may not be nested inside a p element. Therefore replaces this replacer every p that has a div.table-of-contents inside of it with the div directly.

* Add index to replacer function

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

* Add TOC to example code

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

* Remove unused import

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

* Removed unnecessary div wrapper of toc

* Fixed toc-renderer

Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-06-21 14:04:37 +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
public Adds an info banner to the app (#190) 2020-06-15 21:54:20 +02:00
src Added TOC and anchors for headings (#243) 2020-06-21 14:04:37 +02:00
.editorconfig
.gitignore
CHANGELOG.md Add twemoji to changelog 2020-06-20 19:20:51 +02:00
LICENSE
package.json Added TOC and anchors for headings (#243) 2020-06-21 14:04:37 +02:00
README.md
renovate.json Updated schedule of renovate (#192) 2020-06-11 20:57:41 +02:00
tsconfig.json
yarn.lock Added TOC and anchors for headings (#243) 2020-06-21 14:04:37 +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.