https://github.com/20syldev/docs
Documentation de l'API https://api.sylvain.pro
https://github.com/20syldev/docs
api documentation
Last synced: 4 months ago
JSON representation
Documentation de l'API https://api.sylvain.pro
- Host: GitHub
- URL: https://github.com/20syldev/docs
- Owner: 20syldev
- License: bsd-3-clause
- Created: 2024-12-02T11:11:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-01-06T19:10:24.000Z (6 months ago)
- Last Synced: 2026-01-11T15:17:19.398Z (6 months ago)
- Topics: api, documentation
- Language: TypeScript
- Homepage: https://docs.sylvain.pro
- Size: 1010 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Documentation de l'API
[](https://github.com/20syldev/docs/releases/latest)
---
## À propos de la Documentation
Voici la documentation de mon API personnelle, disponible sur le domaine [docs.sylvain.sh](https://docs.sylvain.sh).
## Développement
```bash
# Installer les dépendances
npm install
# Lancer le serveur de développement
npm run dev
# Build pour la production
npm run build
# Prévisualiser le build de production
npm run preview
```
### Composants Vue
| Composant | Description |
| ---------------- | ------------------------------------------------------------------------------------ |
| `Endpoint.vue` | Affiche un endpoint API avec sa méthode HTTP et son chemin cliquable |
| `Lang.vue` | Menu déroulant pour changer de langue (EN/FR) |
| `Layout.vue` | Layout principal, gère la traduction de l'UI, les raccourcis clavier et la page 404 |
| `Method.vue` | Badge coloré pour les méthodes HTTP (GET, POST, PUT, DELETE, PATCH) |
| `Request.vue` | Bloc stylisé pour afficher des exemples de requêtes avec en-tête optionnel |
| `Terminal.vue` | Démo interactive sur la page d'accueil : simule des appels API en temps réel |
| `Version.vue` | Menu déroulant pour naviguer entre les versions de l'API (v1, v2, v3) |
### Modules CSS
| Module | Description |
| ------------------ | -------------------------------------------------------------------------------------- |
| `main.css` | Fichier principal qui importe tous les styles |
| `api.css` | Badges API (méthodes HTTP), endpoints, blocs de requête et liste de paramètres |
| `components.css` | Cartes de version avec badges, effets hover et états (current, stable, legacy) |
| `global.css` | Typographie, scrollbar, page 404 et styles de base |
| `navbar.css` | Styles de la sidebar, badge de version, ordonnancement de la nav, bouton de recherche |
| `overrides.css` | Surcharges VitePress (hero, code, blocs personnalisés, tableaux, dark mode) |
| `pricing.css` | Grille et cartes de la page tarifs avec badges et boutons |
| `responsive.css` | Media queries pour desktop, mobile et impression |
| `terminal.css` | Styles du terminal animé (header, body, curseur clignotant, réponses) |
| `theme.css` | Variables de couleurs (brand, badges HTTP) et thème sombre |
## Déploiement
Le site est généré en HTML statique et peut être déployé sur n'importe quel hébergement statique :
```bash
npm run build
```
Le résultat sera dans `src/.vitepress/dist/`
## Fonctionnalités
- Documentation multi-versions (v1, v2, v3)
- Internationalisation (Anglais, Français)
- Mode sombre
- Recherche locale
- Design responsive
- Composants personnalisés pour la documentation API