Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anchoredapplications/docs

A work-in-progress Astro.js documentation site for publishing various app pages.
https://github.com/anchoredapplications/docs

astro docs

Last synced: 13 days ago
JSON representation

A work-in-progress Astro.js documentation site for publishing various app pages.

Awesome Lists containing this project

README

        

# MatchBot Documentation

Official documentation for **MatchBot**, a matchmaking bot for Discord. This site, built with [Astro](https://astro.build), provides users with information about features, early access details, and contact options.

## Features

- **Introduction**: Overview of MatchBot's purpose and capabilities.
- **Early Access Information**: Details on how to request access.
- **About Section**: Insights into MatchBot's functionalities, including commands and matchmaking features.
- **Contact Information**: Reach out via Discord for questions or feedback.

## Getting Started

To explore the MatchBot documentation, visit the site at [MatchBot Docs](https://matchbot.jeremiah.dev).

### Local Development

To get started with Astro locally:

1. **Clone the Repository**

```bash
git clone https://github.com/anchoredapplications/matchbot-docs.git
cd matchbot-docs
```

2. **Install Dependencies**

Make sure you have [Node.js](https://nodejs.org/) installed, then run:

```bash
npm install
```

3. **Start the Development Server**

Start the local server with:

```bash
npm run dev
```

This will run your Astro site in development mode. Open your browser and navigate to `http://localhost:4321` to view your site.

4. **Build for Production**

To build your site for production, run:

```bash
npm run build
```

This command will generate the static files for your site in the `dist` directory.

## Contact

For inquiries, please reach out on Discord: [@thetradchad](https://discordapp.com/users/thetradchad).

## Contributing

Contributions are welcome! If you'd like to help improve the documentation, please open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.