Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.51 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.51 KB

AOTTG2 FAQ and Help Documentation

This repository contains the documentation site for the Attack on Titan Tribute Game 2 (AOTTG2) Frequently Asked Questions (FAQ) and Help sections. The site is built using Starlight with Astro and TypeScript.

🚀 Project Structure

  • public/: Static assets that will be copied to the build output directory.
  • src/: Source code for the project.
    • assets/: Images, fonts, or other assets used in your documentation.
    • content/: Markdown files for your documentation.
    • components/: Custom Astro components (if any).
    • layouts/: Custom layouts for the pages (if any).
    • styles/: CSS files for custom styling.
  • astro.config.mjs: Astro configuration file.
  • package.json: Project dependencies and scripts.
  • tsconfig.json: TypeScript configuration.
  • README.md: Project documentation (this file).
  • .gitignore: Specifies files that Git should ignore.

🧞 Commands

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

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

👀 Want to learn more?

Check out Starlight's docs, read the Astro documentation.

📝 Content Structure

src/content/docs

Feel free to adjust the structure as needed for your specific AOTTG2 documentation requirements.

🛠 Customization

To customize the look and feel of your documentation site, you can modify the following files:

  • src/styles/custom.css: Add any custom CSS styles here
  • astro.config.mjs: Update site metadata and Starlight configuration

🚀 Deployment

This site can be deployed to your preferred hosting platform. For more information on deploying an Astro site, refer to the Astro deployment guides.

🤝 Contributing

Contributions to improve the AOTTG2 FAQ and Help documentation are welcome. Please contact gisketch on the Discord server.