markdown zen

Markdown禪宗

MarkdownZen 是一個 Web 應用程序，旨在簡化 Markdown 文件的建立和管理。 MarkdownZen 具有使用者友善的介面和強大的功能，是您獲得禪宗 Markdown 體驗的首選工具。

目錄

• 入門
  • 先決條件
  • 安裝
• 用法
• 特徵
• 使用 Docker 運行
• 貢獻
• 執照

入門

先決條件

在開始之前，請確保您的電腦上安裝了以下軟體：

• Node.js
• npm（節點套件管理器）

安裝

1. 克隆儲存庫：

   開啟終端機/命令提示字元並導航到要儲存項目的位置。然後，執行以下命令：

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

這會將專案文件下載到您的電腦。

2. 導航到專案資料夾：

使用cd指令將工作目錄變更為克隆的專案資料夾：

cd markdown-zen

3. 安裝依賴項：

在專案資料夾內，使用單一命令安裝伺服器和客戶端所需的依賴項：

npm run setup-project

這將為應用程式的伺服器和客戶端元件安裝所需的套件。

用法

1. 啟動應用程式：

要啟動該應用程序，請在根 (markdown-zen/) 資料夾中執行以下命令：

npm run dev

此命令同時啟動伺服器和用戶端，因此您可以在瀏覽器中存取應用程式。

2. 存取應用程式：

開啟網頁瀏覽器並前往http://localhost:5173 。您可以在此處找到 MarkdownZen 應用程式。

3. 創建和管理降價：

• 登入或建立帳戶。
• 開始輕鬆建立和管理您的 Markdown 文件。

特徵

• 輕鬆建立、編輯和管理 Markdown 文件。
• 編輯時即時 Markdown 預覽。
• 使用類別和標籤組織降價。
• 安全的身份驗證和授權系統。
• ……

使用 Docker 運行

您也可以使用 Docker 運行 MarkdownZen。請依照下列步驟操作：

1. 拉取 Docker 映像：

   從 Docker Hub 擷取 MarkdownZen Docker 映像：

   docker pull daniel752/markdown-zen:v1.0.0
   

2. 運行容器：

   啟動 MarkdownZen 容器：

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

• -d：以分離模式運作容器（在背景）。
• 該容器將在內部運行連接埠 8000，在外部運行連接埠 5173。

貢獻

我們歡迎社區的貢獻！要為 MarkdownZen 做出貢獻，請按照以下步驟操作：

1. 分叉儲存庫：

點擊 GitHub 儲存庫頁面右上角的「Fork」按鈕。這將在您的 GitHub 帳戶下建立儲存庫的副本。

2. 克隆你的叉子：

將分叉存儲庫克隆到本機：

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

3. 建立一個新分支：

切換到專案目錄：

cd markdown-zen

為您的功能建立一個新分支：

git checkout -b feature/my-new-feature

4. 做出改變：

進行必要的更改並提交：

git commit -m 'Add some feature'

5. 推動您的更改：

將您的變更推送到分叉儲存庫：

git push origin feature/my-new-feature

6. 提交請求請求：

造訪 GitHub 上的原始儲存庫，然後按一下「新拉取請求」按鈕提交您的變更以供審核。

執照

該專案根據 MIT 許可證獲得許可。有關詳細信息，請參閱許可證文件。