Contribution Guides

This repository employs a monorepo setup with pnpm workspaces. It hosts theme Gungnir and a number of plugins for VuePress 2.

 

Pre-requirements

• Node.js version 14+
• pnpm version 7+

 

Development

Clone the repo and install dependencies:

pnpm install

Start watching source files:

pnpm dev

Open another terminal, and start developing the documentation site:

pnpm docs:dev

Main tools that used in this project:

• TypeScript as the development language
• ESLint + Prettier for code linting and formatting

 

License

By contributing to Gungnir, you agree that your contributions will be licensed under its Apache-2.0 (theme) / MIT (plugins) license.