Markdown Architectural Decision Records (MADR) 安装与配置指南

Markdown Architectural Decision Records (MADR) 安装与配置指南

madr Markdown Architectural Decision Records 项目地址: https://gitcode.com/gh_mirrors/ma/madr

1. 项目基础介绍

Markdown Architectural Decision Records（MADR）是一个用于记录项目中的重要架构决策的工具。它使用Markdown格式来撰写决策记录，使得记录更加清晰、易于理解和共享。该项目主要用于帮助团队成员之间沟通和文档化关键决策，以便未来的回顾和参考。

主要编程语言：Markdown

2. 项目使用的关键技术和框架

• Markdown：一种轻量级标记语言，被广泛用于撰写README文件、文档以及本文档的编写。
• Jekyll：一个静态站点生成器，用于将Markdown文件转换成静态网站，便于展示。
• Git：版本控制系统，用于代码的版本管理和协同工作。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装之前，请确保您的系统中已经安装以下软件：

• Git：用于克隆和操作项目仓库。
• Ruby：Jekyll的运行环境。
• Node.js：用于运行一些辅助工具。

安装步骤

步骤1：克隆项目仓库

首先，您需要从GitHub上克隆MADR项目仓库到本地：

git clone https://github.com/adr/madr.git
cd madr

步骤2：安装Ruby和Jekyll

确保您的系统已经安装了Ruby。如果没有，请按照系统的包管理器的指示进行安装。接下来，安装Jekyll：

gem install bundler
bundle install

步骤3：启动Jekyll服务

在项目目录中，运行以下命令来启动Jekyll服务：

bundle exec jekyll serve

启动完成后，您可以在浏览器中访问 http://localhost:4000/madr/ 来查看项目文档。

步骤4：配置项目

MADR项目的配置主要通过修改项目目录中的 _config.yml 文件来进行。您可以在这里自定义网站标题、描述、主题样式等。

步骤5：撰写和添加ADR

创建新的ADR文件，将其放置在 docs/decisions 目录下。文件名应遵循格式 nnnn-title.md，其中 nnnn 是一个递增的数字，title 是决策的简短描述。

使用提供的模板文件 template/adr-template.md 作为新ADR的起点，并根据需要进行修改。

步骤6：构建项目

完成ADR的撰写后，您可以构建项目来生成静态网站：

bundle exec jekyll build

构建的静态文件将位于 _site 目录中。

步骤7：部署项目

将构建好的静态文件部署到您的服务器或者使用GitHub Pages服务。

以上是MADR的基本安装和配置指南。按照这些步骤，您应该能够成功地在本地运行和自定义MADR项目。

madr Markdown Architectural Decision Records 项目地址: https://gitcode.com/gh_mirrors/ma/madr