Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add VitePress to the Repository #19

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Mateleo
Copy link

@Mateleo Mateleo commented Mar 9, 2025

This PR introduces VitePress as the documentation tool for the repository. I believe it's a good choice for its simplicity, speed, and Markdown-first approach, which aligns perfectly with our needs for documenting the Generals & Zero Hour community project.

What's Changed

  • Added VitePress configuration and setup.
  • Created a basic homepage.
  • Marmaid support as requested by @tintinhamans
  • No conflicts with main !

Things you need to know

the _Footer and _Navbar files are not used, I hardcoded the contents of these files myself. Everything can be modified in .vitepress/config.mts.

How to Test

You will need pnpm

  1. Install dependencies: pnpm i
  2. run the project: npm run dev

image

@Mateleo Mateleo changed the title vitepress init Add VitePress to the Repository Mar 9, 2025
@Mateleo
Copy link
Author

Mateleo commented Mar 9, 2025

image

@Mateleo
Copy link
Author

Mateleo commented Mar 9, 2025

image

@tintinhamans tintinhamans added the enhancement New feature or request label Mar 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants