Skip to content

2u841r/voidtools

Repository files navigation

Voidtools Fanmade Site

Built with Starlight

This is a fanmade website for Voidtools built using Astro with the Starlight starter kit.


🧞 Available Commands

Run these commands from the project root:

Command Description
npm install Install dependencies
npm run dev Start the local dev server at http://localhost:4321
npm run build Build production site into ./dist/
npm run preview Preview your production build locally
npm run astro ... Run Astro CLI commands like astro add, astro check
npm run astro -- --help Show help for the Astro CLI

📝 Adding Content

  • Markdown files (.md or .mdx) go in src/content/docs/.
  • Each file is automatically available as a route based on its file name.
  • Images can be placed in src/assets/ and referenced with relative paths in your Markdown files.

Project Structure

.
├── public/                 # Static assets (favicons, images, etc.)
├── src/
│   ├── assets/             # Images and other media
│   ├── content/
│   │   └── docs/           # Markdown (.md/.mdx) files for your site
│   └── content.config.ts   # Starlight content configuration
├── astro.config.mjs        # Astro configuration
├── package.json
└── tsconfig.json
  • Starlight automatically exposes .md or .mdx files in src/content/docs/ as routes.
  • Images can be added to src/assets/ and used in Markdown with relative links.
  • Static assets like favicons should go in the public/ folder.

📚 Learn More


📝 License

This project is licensed under the MIT License.

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors