mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
Kyrch
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
<p align="center">
|
|
<a href="https://discordapp.com/invite/m9zbVyQ"><img src="https://img.shields.io/discord/354388306580078594.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2"></a>
|
|
<a href="https://github.com/AnimeThemes/animethemes-server/blob/main/LICENSE"><img src="https://img.shields.io/github/license/AnimeThemes/animethemes-server"></a>
|
|
<a href="https://reddit.com/r/AnimeThemes"><img src="https://img.shields.io/reddit/subreddit-subscribers/AnimeThemes?style=social"></a>
|
|
<a href="https://twitter.com/AnimeThemesMoe"><img src="https://img.shields.io/twitter/follow/AnimeThemesMoe?style=social"></a>
|
|
</p>
|
|
|
|
## Introduction
|
|
|
|
[**AnimeThemes**](https://animethemes.moe/) is a simple and consistent repository of anime opening and ending themes. We provide direct links to high quality WebMs of your favorite OPs and EDs for your listening and discussion needs.
|
|
|
|
The AnimeThemes API provides access to our repository resources for your development needs.
|
|
|
|
This is the repository for the [**AnimeThemes.moe API documentation**](https://api-docs.animethemes.moe/).
|
|
|
|
This project is powered by [**VitePress**](https://vitepress.vuejs.org/), a Vite & Vue Powered Static Site Generator.
|
|
|
|
## Installation
|
|
|
|
In the project root directory, install dependencies.
|
|
|
|
`bun install`
|
|
|
|
In the project root directory, start the local development server.
|
|
|
|
`bun run docs:dev`
|
|
|
|
That's it! The local development server should be running at `localhost:5173`.
|
|
|
|
## Contributing
|
|
|
|
Please review the [**Contributing Guide**](https://github.com/AnimeThemes/animethemes-api-docs/blob/main/CONTRIBUTING.md) for detailed instructions.
|
|
|
|
## Deployment
|
|
|
|
Please review the [**Deployment Guide**](https://github.com/AnimeThemes/animethemes-api-docs/blob/main/DEPLOYMENT.md) for detailed instructions.
|
|
|
|
## Resources
|
|
|
|
For API support, please make use of the **#api** channel in the [**Discord Server**](https://discordapp.com/invite/m9zbVyQ).
|
|
|
|
To report an issue with or request a new feature for the API, please make use of the [**animethemes-server**](https://github.com/AnimeThemes/animethemes-server) Github.
|
|
|
|
To report an issue with or request a new feature for this documentation, please make use of this repository. |