-
Notifications
You must be signed in to change notification settings - Fork 19
Add VitePress to the Repository #19
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
base: main
Are you sure you want to change the base?
Conversation
How does this compare to what we have now? Is it a theme that changes the layout? Does it work out of the box on github once we merge it? |
@roossienb Sorry I'm a bit out of the loop rn. Vitepress is a way to create beautiful documentation sites with markdown files. It's just a super-quick and pretty way to have a wiki website. |
Is it something you would be willing to put time in and maintain? |
@roossienb Yes it was my goal. But first I need to be sure of the objectives and the need. You want a site to display the documentation? Something extra/special? |
At this point not super clear where the wiki is heading. The generalsgamecode consists of information about
In the future, it may as well contain more user facing information. |
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
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
pnpm i
npm run dev