Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 3.15 KB

README.md

File metadata and controls

114 lines (79 loc) · 3.15 KB

Astro HTML CSS MDX

Vercel Website status

SP Homebrew Guide

A homebrew guide for the Nintendo Switch

This project is built with Starlight documentation framework on top of Astro web framework.

Table of Contents

Installation

To install and run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Sylvixor/SP.git

  2. Navigate to the project directory:

    cd SP

  3. Install the dependencies:

    npm install

Usage

To start the development server, run:

npm run dev

or

npm start

To build the project for production:

npm run build

To preview the production build locally:

npm run preview

Configuration

The project includes the following configuration files:

  • astro.config.mjs: Configuration for the Astro project.
  • tsconfig.json: TypeScript configuration file.
  • package.json: Lists the project's dependencies and scripts.
  • .gitignore: Specifies which files and folders to ignore in version control.

You can modify these files as needed to fit the requirements of your project.

Folder Structure

Here is an overview of the project structure:

/
├── public/              # Static assets
├── src/                 # Source files for the website
│   ├── assets/          # Documentation assets
│   ├── content/         # Documentation content
│   │   └── docs/        # Documentation pages
│   ├── fonts/           # Documentation fonts
│   ├── pages/           # Other pages (HTML)
│   └── styles/          # Documentation custom CSS
├── astro.config.mjs     # Astro configuration file
├── package.json         # Project metadata and dependencies
├── package-lock.json    # Lock file for package versions
├── tsconfig.json        # TypeScript configuration
└── .gitignore           # Files to ignore in Git

License

SP © 2024 by Sylvixor is licensed under CC BY-NC-SA 4.0

Acknowledgements

Special thanks to:

  • The Astro team for developing such a great framework.
  • All contributors of the Starlight framework.
  • All contributors and libraries used in this project.