Markdown Viewer 项目教程

1. 项目的目录结构及介绍

Markdown Viewer 项目的目录结构如下：

markdown-viewer/
├── chrome/
│   ├── components/
│   └── lib/
├── test/
├── bower.json
├── build.bat
├── build.sh
├── chrome.manifest
├── install.rdf
├── LICENSE
├── README.md
└── bower_components/

目录结构介绍

• chrome/: 包含项目的核心代码和组件。
  • components/: 存放项目的组件文件。
  • lib/: 存放项目的依赖库文件。
• test/: 存放项目的测试文件。
• bower.json: 项目的 Bower 配置文件，用于管理前端依赖。
• build.bat: Windows 系统下的构建脚本。
• build.sh: Linux 系统下的构建脚本。
• chrome.manifest: Chrome 扩展的清单文件。
• install.rdf: 安装配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• bower_components/: 存放通过 Bower 安装的依赖库。

2. 项目的启动文件介绍

Markdown Viewer 项目的启动文件主要是 chrome.manifest 和 install.rdf。

chrome.manifest

chrome.manifest 是 Chrome 扩展的清单文件，定义了扩展的基本信息和资源路径。以下是该文件的部分内容：

content markdown-viewer chrome/components/
overlay chrome://browser/content/browser.xul chrome://markdown-viewer/content/overlay.xul

install.rdf

install.rdf 是安装配置文件，定义了扩展的元数据，如扩展的 ID、版本号、作者信息等。以下是该文件的部分内容：

<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#">
  <Description about="urn:mozilla:install-manifest">
    <em:id>[e-mail]</em:id>
    <em:version>1.0</em:version>
    <em:type>2</em:type>
    <em:name>Markdown Viewer</em:name>
    <em:description>A Markdown Viewer add-on for Firefox.</em:description>
    <em:creator>Thiht</em:creator>
    <em:homepageURL>https://github.com/Thiht/markdown-viewer</em:homepageURL>
  </Description>
</RDF>

3. 项目的配置文件介绍

Markdown Viewer 项目的主要配置文件包括 bower.json 和 build.bat/build.sh。

bower.json

bower.json 是 Bower 的配置文件，用于管理前端依赖。以下是该文件的部分内容：

{
  "name": "markdown-viewer",
  "version": "1.0.0",
  "dependencies": {
    "marked": "~0.3.2"
  }
}

build.bat 和 build.sh

build.bat 和 build.sh 分别是 Windows 和 Linux 系统下的构建脚本。它们用于生成项目的 .xpi 文件，以便在 Firefox 中安装。

build.bat

@echo off
echo Building Markdown Viewer...
7z a markdown-viewer.xpi chrome components install.rdf chrome.manifest

build.sh

#!/bin/bash
echo "Building Markdown Viewer..."
zip -r markdown-viewer.xpi chrome components install.rdf chrome.manifest

通过这些配置文件和脚本，开发者可以轻松地构建和配置 Markdown Viewer 项目。