https://github.com/lumishell/newstar-docs
Source code of NewStar CTF documentation website.
https://github.com/lumishell/newstar-docs
capture-the-flag ctf ctf-game documentation giscus newstar writeup writeup-ctf
Last synced: 7 months ago
JSON representation
Source code of NewStar CTF documentation website.
- Host: GitHub
- URL: https://github.com/lumishell/newstar-docs
- Owner: lumishell
- License: mit
- Created: 2024-08-30T14:19:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-27T18:06:20.000Z (7 months ago)
- Last Synced: 2025-02-28T01:53:33.576Z (7 months ago)
- Topics: capture-the-flag, ctf, ctf-game, documentation, giscus, newstar, writeup, writeup-ctf
- Language: Vue
- Homepage: https://ns.openctf.net
- Size: 65.2 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```shell
pnpm install
```
Run package command to build the document.
```shell
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.
```shell
pnpm run docs:dev
```
VitePress configuration is located at [vitepress.config.ts](./vitepress.config.ts).
Theme configuration is located at [theme-config.yml](./theme-config.yml). It's mostly nav and sitebar configuration. For other theme configurations, it's recommended to modify [vitepress.config.ts](./vitepress.config.ts) with type hints.
Theme at [theme/](./theme/), which has path alias `@`.
All the documentations are located at [docs/](./docs/), which has the path alias `@docs`.
The static files are located at [public/](./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/](./theme/components/docs/).
## License
Copyright (c) NewStar CTF. All rights reserved.
Licensed under the [MIT](LICENSE) License.