Hexo Renderer Marked 使用教程

Hexo Renderer Marked 使用教程

hexo-renderer-markedMarkdown renderer for Hexo项目地址:https://gitcode.com/gh_mirrors/he/hexo-renderer-marked

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

Hexo Renderer Marked 是一个用于 Hexo 博客框架的 Markdown 渲染插件。其目录结构相对简单，主要包含以下几个部分：

hexo-renderer-marked/
├── lib/
│   ├── filters.js
│   ├── marked.js
│   └── renderer.js
├── index.js
├── package.json
└── README.md

• lib/ 目录：包含插件的核心逻辑文件。
  • filters.js：定义了一些过滤器，用于处理 Markdown 文本。
  • marked.js：封装了 Marked 库的调用。
  • renderer.js：自定义渲染器，用于扩展 Marked 的功能。
• index.js：插件的入口文件，负责初始化和加载其他模块。
• package.json：项目的元数据文件，包含依赖、版本等信息。
• README.md：项目的说明文档，介绍插件的基本用法和配置。

2. 项目的启动文件介绍

Hexo Renderer Marked 的启动文件是 index.js。该文件主要负责初始化插件并加载必要的模块。以下是 index.js 的主要内容：

'use strict';

var marked = require('./lib/marked');
var renderer = require('./lib/renderer');
var filters = require('./lib/filters');

function hexoRendererMarked(hexo) {
  hexo.extend.renderer.register('md', 'html', marked(hexo, renderer));
  filters(hexo);
}

module.exports = hexoRendererMarked;

• require 语句：加载 lib 目录下的 marked.js、renderer.js 和 filters.js 文件。
• hexoRendererMarked 函数：注册 Markdown 渲染器，并应用过滤器。
• module.exports：导出插件的主函数，供 Hexo 调用。

3. 项目的配置文件介绍

Hexo Renderer Marked 的配置主要通过 Hexo 的配置文件 _config.yml 进行。以下是一个基本的配置示例：

marked:
  gfm: true
  pedantic: false
  sanitize: false
  tables: true
  breaks: true
  smartLists: true
  smartypants: true
  modifyAnchors: ''
  autolink: true

• gfm：启用 GitHub Flavored Markdown。
• pedantic：尽可能地符合 Markdown 的原始规范。
• sanitize：是否对输出进行清理。
• tables：是否支持 GFM 表格。
• breaks：是否支持 GFM 换行。
• smartLists：是否使用更智能的列表缩进。
• smartypants：是否使用智能标点替换。
• modifyAnchors：修改锚点的格式。
• autolink：是否自动将 URL 转换为链接。

通过这些配置项，可以灵活地调整 Markdown 渲染的行为，以满足不同的需求。

hexo-renderer-markedMarkdown renderer for Hexo项目地址:https://gitcode.com/gh_mirrors/he/hexo-renderer-marked