kramed 项目使用教程

kramed 项目使用教程

项目的目录结构及介绍

kramed 项目的目录结构如下：

kramed/
├── lib/
│   └── test/
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .jscsrc
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── index.js
├── package.json

• lib/：包含项目的主要代码文件。
• test/：包含项目的测试文件。
• .eslintignore、.eslintrc、.gitignore、.jscsrc、.npmignore、.travis.yml：分别是 ESLint 配置、Git 忽略文件、JSCS 配置、NPM 忽略文件和 Travis CI 配置文件。
• LICENSE：项目的许可证文件。
• README.md：项目的说明文档。
• index.js：项目的入口文件。
• package.json：项目的配置文件，包含依赖、脚本等信息。

项目的启动文件介绍

项目的启动文件是 index.js。这个文件是 kramed 的入口点，负责初始化和导出 kramed 的主要功能。以下是 index.js 的简要介绍：

var kramed = require('kramed');
console.log(kramed('I am using __markdown__ '));
// Outputs: <p>I am using <strong>markdown</strong> </p>

通过这个文件，你可以直接使用 kramed 来渲染 Markdown 文本。

项目的配置文件介绍

项目的配置文件主要是 package.json。这个文件包含了项目的基本信息、依赖、脚本等配置。以下是 package.json 的部分内容：

{
  "name": "kramed",
  "version": "0.5.6",
  "description": "A markdown parser using kramed engine",
  "main": "index.js",
  "scripts": {
    "test": "node test --fix",
    "bench": "node test --bench"
  },
  "dependencies": {
    "kramed-renderer": "^0.2.0"
  },
  "devDependencies": {
    "eslint": "^3.19.0",
    "jscs": "^3.0.7"
  }
}

• name：项目名称。
• version：项目版本。
• description：项目描述。
• main：项目的入口文件。
• scripts：包含项目的脚本命令，如测试和基准测试。
• dependencies 和 devDependencies：项目的依赖包。

通过这些配置文件，你可以了解项目的依赖关系、如何运行测试和基准测试等重要信息。