* Update links * Update table of contents * Improve the design * Improve formatting * Fix abbreviations and proper names * Fix tables * Fix indentation in code snippets * Fix typos
45 lines
684 B
Markdown
45 lines
684 B
Markdown
# Remark42 site
|
|
|
|
## Work on your local environment
|
|
|
|
Requirements:
|
|
|
|
* [Node.js v14](https://nodejs.org/en/) or higher - install from package or with Homebrew
|
|
* Yarn 1.22 or higher - once you have Node.js, run `npm i -g yarn`
|
|
|
|
### Development
|
|
|
|
Install dependencies and start the development server:
|
|
|
|
```shell
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
### Build
|
|
|
|
```shell
|
|
yarn build
|
|
```
|
|
|
|
## Work with Docker Compose
|
|
|
|
### Build
|
|
|
|
Install dependencies and run development server inside Docker:
|
|
|
|
```shell
|
|
docker-compose build
|
|
docker-compose up server
|
|
```
|
|
|
|
Then serve files from `./build` with your favorite server
|
|
|
|
### Development
|
|
|
|
```shell
|
|
docker-compose up --build server
|
|
```
|
|
|
|
Then head to http://localhost:8080
|