contributing.md

Contributing Guide

Development Setup

Node.js

The version number is stored in this file: .nvmrc.

After the corresponding Node.js is installed, run:

# set up .env
cp .env.example .env
# then fill out the .env

# install dependencies
npm install

# start the development server
npm run dev

# build static files for deployment
npm run build

Atom Feed Preview

Feed contents are built with VitePress's buildEnd build hook, so you need to run build & preview to see the results:

npm run build
npm run preview

There are several other npm script commands that you might want to use in the scripts part of package.json.

Visual Studio Code

If you're using Visual Studio Code, the extensions below are really helpful for you to set up the development environment:

• ESLint
• markdownlint
• Vue - Official