markdown zen

DémarquageZen

MarkdownZen est une application Web conçue pour rationaliser la création et la gestion de documents markdown. Avec une interface conviviale et des fonctionnalités puissantes, MarkdownZen est votre outil incontournable pour une expérience de démarque zen.

Table des matières

• Commencer
  • Conditions préalables
  • Installation
• Usage
• Caractéristiques
• Exécuter avec Docker
• Contribuer
• Licence

Commencer

Conditions préalables

Avant de commencer, assurez-vous que les logiciels suivants sont installés sur votre ordinateur :

• Noeud.js
• npm (gestionnaire de packages de nœuds)

Installation

1. Clonez le dépôt :

   Ouvrez votre terminal/invite de commande et accédez à l'emplacement où vous souhaitez stocker le projet. Ensuite, exécutez la commande suivante :

git clone https://github.com/daniel752/markdown-zen.git

Cela téléchargera les fichiers du projet sur votre ordinateur.

2. Accédez au dossier du projet :

Utilisez la commande cd pour remplacer votre répertoire de travail par le dossier du projet cloné :

cd markdown-zen

3. Dépendances d'installation :

Dans le dossier du projet, installez les dépendances nécessaires pour le serveur et le client à l'aide d'une seule commande :

npm run setup-project

Cela installera les packages requis pour les composants serveur et client de l'application.

Usage

1. Démarrez l'application :

Pour lancer l'application, exécutez la commande suivante dans le dossier racine (markdown-zen/) :

npm run dev

Cette commande démarre simultanément le serveur et le client, afin que vous puissiez accéder à l'application dans votre navigateur.

2. Accédez à l'application :

Ouvrez votre navigateur Web et accédez à http://localhost:5173 . C'est ici que vous trouverez l'application MarkdownZen.

3. Création et gestion des démarques :

• Connectez-vous ou créez un compte.
• Commencez à créer et à gérer vos documents markdown sans effort.

Caractéristiques

• Créez, modifiez et gérez facilement des documents démarques.
• Aperçu des démarques en temps réel pendant l'édition.
• Organisez les démarques à l’aide de catégories et de balises.
• Système d’authentification et d’autorisation sécurisé.
• ...

Exécuter avec Docker

Vous pouvez également exécuter MarkdownZen à l'aide de Docker. Suivez ces étapes :

1. Extrayez l'image Docker :

   Extrayez l'image MarkdownZen Docker de Docker Hub :

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Exécutez le conteneur :

   Démarrez le conteneur MarkdownZen :

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d : Exécuter le conteneur en mode détaché (en arrière-plan).
• Le conteneur exécutera le port 8000 à l’intérieur et 5173 à l’extérieur.

Contribuer

Nous apprécions les contributions de la communauté ! Pour contribuer à MarkdownZen, suivez ces étapes :

1. Forkez le référentiel :

Cliquez sur le bouton « Fork » en haut à droite de la page du référentiel GitHub. Cela crée une copie du référentiel sous votre compte GitHub.

2. Clonez votre fourchette :

Clonez votre référentiel forké sur votre machine locale :

git clone https://github.com/your-username/markdown-zen.git

3. Créer une nouvelle branche :

Accédez au répertoire du projet :

cd markdown-zen

Créez une nouvelle branche pour votre fonctionnalité :

git checkout -b feature/my-new-feature

4. Apporter des modifications :

Apportez les modifications nécessaires et validez-les :

git commit -m 'Add some feature'

5. Poussez vos modifications :

Envoyez vos modifications vers votre référentiel forké :

git push origin feature/my-new-feature

6. Soumettre une demande de tirage :

Visitez le référentiel d'origine sur GitHub et cliquez sur le bouton « Nouvelle demande de tirage » pour soumettre vos modifications pour examen.

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.