Add text annotations to Markdown documents, similar comments in Google Docs or Microsoft word. The annotations are stored in the Markdown document itself so they travel along with the content through the editing and review cycle.
npm run buildbuilds the production version of the browser applicationnpm run startserves the application at https://localhost:5000 over HTTP/2 (See the one-time “Generating HTTPS Certificates” below)
- Node.js 12+ to compile the browser application and serve it in development mode
- mkcert (Optional) to generate HTTPS certificates
It’s likely in production that your application will be served over HTTPS. While standing up an HTTP server on localhost is easy for development, browsers behave differently in subtle ways when serving content over HTTPS. Thus it’s important to account for this in development.
The following uses the open-source mkcert utility to create self-signed certificates used to configure an HTTPS for localhost along with a trusted certificate authority so your browser doesn’t warn you each time. mkcert just automates the complex process of generating certs. You can use other tools to generate the keys. Self-signing and one-off certificate authorities are not suitable for a production application.
brew install mkcertinstalls mkcertmkcert -installinitializes mkcert and adds a trusted certificate authority to the Keychain. Caution: This is a potential security risk.mkcert localhostcreates two*.pemfiles in the current directory that should not be checked into version control. (See.gitignore.) These files are referenced inpackage.jsonto configure the primary web server (defaults to port 5000) androllup.config.jsfor live reload during development (defaults to port 35729). If you’ve used a different tool to create your keys, you might need to adjust these paths.
npm run devlistens for source file changes and hot reloads the application