NewStar CTF

This project is a documentation website for NewStar CTF.

Build the project

Clone the project and install the dependencies with your preferred package manager.

pnpm install

Run package command to build the document.

pnpm run docs:build

Files will be generated in the dist directory at the root of the project.

Development

To start the development server, run the following command.

pnpm run docs:dev

VitePress configuration is located at vitepress.config.ts.

Theme configuration is located at theme-config.yml. It's mostly nav and sitebar configuration. For other theme configurations, it's recommended to modify vitepress.config.ts with type hints.

Theme at theme/, which has path alias @.

All the documentations are located at docs/, which has the path alias @docs.

The static files are located at public/.

For static assets which might be bundled, it's recommended to put them in the assets directory in the docs directory. For example, image files.

To use Vue in markdown, related components are most defined at theme/components/docs/.

License

Copyright (c) NewStar CTF. All rights reserved.

Licensed under the MIT License.