splashkit.io Website - Starlight Framework

Welcome to the official documentation website for the SplashKit SDK, using the Starlight (Astro) framework! This README will guide you through the installation process and provide an overview of the features and functionalities of the SDK.

splashkit/splashkit.io-starlight

thoth-tech/splashkit.io-starlight *

* SplashKit Development in Thoth Tech

Thoth Tech is a people-focused educational technology company within Deakin University's capstone program which provides real-world learning opportunities and allows students to contribute significantly to projects like SplashKit, enhancing its capabilities and resources.

Installation

To work on the SplashKit website locally:

1. Fork and clone this repository.

2. Open the project in VS Code or your preferred editor.

3. Install dependencies:

   npm install
   

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
│   ├── gifs/
│   ├── images/
│   ├── resources/
│   └── usage-examples/
├── scripts/
└── src/
    ├── assets/
    ├── components/
    ├── content/
    │   ├── docs/
    │   │   ├── api/
    │   │   ├── guides/
    │   │   ├── installation/
    │   │   ├── troubleshoot/
    │   │   └── arcade-hackathon-project/
    ├── fonts/
    ├── styles/
    <!-- ├── config.ts -->
    └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

• Documentation Files: Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.
• Images and Assets: Images can be added to src/assets/ and embedded in Markdown with a relative link.
• Static Assets: Static assets, like favicons and gifs, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project in a terminal:

Command	Action
npm install	Installs project dependencies
npm run dev	Runs setup scripts, then starts the local dev server at localhost:4321
npm run start	Runs setup scripts, then starts the local dev server
npm run build	Runs setup scripts, then builds the production site to ./dist/
npm run preview	Previews the built site locally
npm run astro ...	Runs Astro CLI commands
npm run astro -- --help	Shows help for the Astro CLI
npm run setup	Generates JSON files, usage example data, and API pages
npm run generate-mdx	Generates API page content
npm run generate-json	Generates JSON and usage example data
npm run check-links	Enables link checking during build

Notes

The project runs setup scripts before npm run dev, npm run start, and npm run build. These scripts prepare generated content such as JSON files, usage examples, and API pages.

Contributing

We welcome contributions from the community to enhance the SplashKit SDK on the Starlight framework. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTE.md file.