typogr.js 技术文档

1. 安装指南

推荐使用 npm 进行安装：

npm install -g typogr

2. 项目使用说明

typogr.js 是一个无需外部依赖的库，它可以在服务器和浏览器中使用。

服务器端使用方法

// 仅适用于服务器端
var typogr = require('typogr');

typogr.typogrify('<h1>"Pretty header ...</h1>');
// 输出: '<h1><span class="dquo">&#8220;</span>Pretty header&nbsp;&#8230;</h1>'

浏览器中使用方法

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/ekalinin/typogr.js@0.6.7/typogr.min.js"></script>
<script>
$(document).ready(function() {
    $('#res').html(typogr.typogrify($('#src')));
});
</script>

面向对象风格

// 仅适用于服务器端
var typogr = require('typogr');

typogr('<h1>"Pretty header ...</h1>').typogrify();
// 输出: '<h1><span class="dquo">&#8220;</span>Pretty header&nbsp;&#8230;</h1>'

链式操作

// 仅适用于服务器端
var typogr = require('typogr');

typogr('<h1>"Pretty header ...</h1>').chain().initQuotes().value();
// 输出: '<h1><span class="dquo">"</span>Pretty header ...</h1>'

typogr('<h1>"Pretty header ...</h1>').chain().initQuotes().smartypants().value();
// 输出: '<h1><span class="dquo">&#8220;</span>Pretty header &#8230;</h1>'

3. 项目API使用文档

以下是 typogr.js 的 API 文档：

• amp: 将与空格或   相邻的与号 (&) 用 <span class="amp"> 包裹起来，同时将所有与号转换为 &。
• initQuotes: 将首部引号用 <span class="dquo">（对于双引号）或 <span class="quo">（对于单引号）包裹起来。
• smartypants: 将直引号转换为弯引号 HTML 实体，将连续的三个点转换为省略号实体。
• widont: 在字符串的最后两个单词之间用   替换空格，避免最后一行只有一个单词。
• caps: 将多个连续的大写字母包裹在 <span class="caps"></span> 中。
• ord: 将数字后缀包裹在 <span class="ord"></span> 中。
• typogrify: 按顺序应用上述所有过滤器。

4. 项目安装方式

项目安装方式已在“安装指南”部分详细描述，请参考上文。