Skip to content

Docteur-Parfait/docBase

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocBase 📚

Base de données centralisée pour organiser vos documentations techniques avec React et Vite.

🚀 Installation rapide

git clone https://github.com/votre-username/docBase.git
cd docBase
npm install
npm run dev

Ouvrez http://localhost:3000 dans votre navigateur.

📁 Structure du projet

docBase/
├── src/
│   ├── components/         # Composants React
│   ├── docs/              # Vos documentations (.md)
│   ├── assets/            # Images et ressources
│   └── templates/         # Templates de documentation
├── index.html             # Point d'entrée
└── package.json           # Configuration

➕ Ajouter une documentation

Documentation locale (fichier .md)

  1. Créez un fichier dans src/docs/ : touch src/docs/mon-guide.md
  2. Ajoutez dans DocumentationList.tsx :
{
  title: "Votre Titre",
  description: "Description courte et claire",
  link: "/docs/mon-guide.md"
}

Documentation externe (lien web)

{
  title: "Nom de la ressource",
  description: "Description de la ressource",
  link: "https://lien-externe.com"
}

📝 Format recommandé

# Titre de votre documentation

Description courte de ce que couvre cette documentation.

## Section 1
Contenu de votre documentation...

## Exemples
```bash
commande-exemple

## 🔧 Scripts disponibles

```bash
npm run dev      # Démarre le serveur de développement
npm run build    # Construit la version de production
npm run serve    # Prévisualise la build de production

📋 Types de contributions

  • Documentations techniques (frameworks, langages, outils)
  • Tutoriels pas-à-pas
  • Guides de bonnes pratiques
  • Ressources utiles et liens externes

📄 Licence

MIT License - Libre d'utilisation et de modification.


🚀 Contribuez pour rendre la documentation plus accessible !

About

Le projet qui permet d'ajouter des documentations

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •