markdown zen

MarkdownZen

MarkdownZen ist eine Webanwendung zur Optimierung der Erstellung und Verwaltung von Markdown-Dokumenten. Mit einer benutzerfreundlichen Oberfläche und leistungsstarken Funktionen ist MarkdownZen Ihr bevorzugtes Tool für ein zen-volles Markdown-Erlebnis.

Inhaltsverzeichnis

• Erste Schritte
  • Voraussetzungen
  • Installation
• Verwendung
• Merkmale
• Laufen mit Docker
• Mitwirken
• Lizenz

Erste Schritte

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass die folgende Software auf Ihrem Computer installiert ist:

• Node.js
• npm (Node Package Manager)

Installation

1. Klonen Sie das Repository :

   Öffnen Sie Ihr Terminal/Ihre Eingabeaufforderung und navigieren Sie zu dem Speicherort, an dem Sie das Projekt speichern möchten. Führen Sie dann den folgenden Befehl aus:

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

Dadurch werden die Projektdateien auf Ihren Computer heruntergeladen.

2. Navigieren Sie zum Projektordner :

Verwenden Sie den Befehl cd , um Ihr Arbeitsverzeichnis in den geklonten Projektordner zu ändern:

cd markdown-zen

3. Abhängigkeiten installieren :

Installieren Sie im Projektordner die erforderlichen Abhängigkeiten sowohl für den Server als auch für den Client mit einem einzigen Befehl:

npm run setup-project

Dadurch werden die erforderlichen Pakete für die Server- und Clientkomponenten der App installiert.

Verwendung

1. Starten Sie die Anwendung :

Um die Anwendung zu starten, führen Sie den folgenden Befehl im Stammordner (markdown-zen/) aus:

npm run dev

Dieser Befehl startet gleichzeitig den Server und den Client, sodass Sie in Ihrem Browser auf die App zugreifen können.

2. Greifen Sie auf die App zu :

Öffnen Sie Ihren Webbrowser und gehen Sie zu http://localhost:5173 . Hier finden Sie die MarkdownZen-App.

3. Markdowns erstellen und verwalten :

• Melden Sie sich an oder erstellen Sie ein Konto.
• Beginnen Sie mühelos mit der Erstellung und Verwaltung Ihrer Markdown-Dokumente.

Merkmale

• Erstellen, bearbeiten und verwalten Sie Markdown-Dokumente ganz einfach.
• Markdown-Vorschau in Echtzeit während der Bearbeitung.
• Organisieren Sie Abschläge mithilfe von Kategorien und Tags.
• Sicheres Authentifizierungs- und Autorisierungssystem.
• ...

Laufen mit Docker

Sie können MarkdownZen auch mit Docker ausführen. Befolgen Sie diese Schritte:

1. Ziehen Sie das Docker-Image :

   Rufen Sie das MarkdownZen Docker-Image vom Docker Hub ab:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Führen Sie den Container aus :

   Starten Sie den MarkdownZen-Container:

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

• -d: Den Container im getrennten Modus ausführen (im Hintergrund).
• Der Container läuft innen über Port 8000 und außen über Port 5173.

Mitwirken

Wir freuen uns über Beiträge aus der Community! Um zu MarkdownZen beizutragen, gehen Sie folgendermaßen vor:

1. Forken Sie das Repository :

Klicken Sie oben rechts auf der GitHub-Repository-Seite auf die Schaltfläche „Fork“. Dadurch wird eine Kopie des Repositorys unter Ihrem GitHub-Konto erstellt.

2. Klonen Sie Ihre Gabel :

Klonen Sie Ihr geforktes Repository auf Ihren lokalen Computer:

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

3. Erstellen Sie einen neuen Zweig :

Wechseln Sie in das Projektverzeichnis:

cd markdown-zen

Erstellen Sie einen neuen Zweig für Ihr Feature:

git checkout -b feature/my-new-feature

4. Nehmen Sie Änderungen vor :

Nehmen Sie die erforderlichen Änderungen vor und übernehmen Sie sie:

git commit -m 'Add some feature'

5. Pushen Sie Ihre Änderungen :

Übertragen Sie Ihre Änderungen in Ihr geforktes Repository:

git push origin feature/my-new-feature

6. Senden Sie eine Pull-Anfrage :

Besuchen Sie das Original-Repository auf GitHub und klicken Sie auf die Schaltfläche „Neue Pull-Anfrage“, um Ihre Änderungen zur Überprüfung einzureichen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert. Einzelheiten finden Sie in der LICENSE-Datei.