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 许可证获得许可。有关详细信息，请参阅许可证文件。