https://github.com/alexgalhardo/docs.games.alexgalhardo.com
Awesome developer experience API documentation while building games.alexgalhardo.com
https://github.com/alexgalhardo/docs.games.alexgalhardo.com
api-documentation api-rest documentation mintlify
Last synced: 3 months ago
JSON representation
Awesome developer experience API documentation while building games.alexgalhardo.com
- Host: GitHub
- URL: https://github.com/alexgalhardo/docs.games.alexgalhardo.com
- Owner: AlexGalhardo
- Created: 2023-05-18T16:20:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T14:38:19.000Z (10 months ago)
- Last Synced: 2025-02-24T06:51:55.864Z (3 months ago)
- Topics: api-documentation, api-rest, documentation, mintlify
- Language: MDX
- Homepage: https://docs.games.alexgalhardo.com
- Size: 6.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
- A personal project I created to improve my API documentation skills for an awesome developer experience (DX) while building [https://games.alexgalhardo.com](https://games.alexgalhardo.com)
## Front-End & API
- FrontEnd Source code:
- BackEnd API Source Code:
### Development Setup Local
- Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
```bash
npm i -g mintlify
```
Run the following command at the root of your documentation (where mint.json is)
```bash
mintlify dev
```
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) August 2023-present, [Alex Galhardo](https://github.com/AlexGalhardo)