首页
/ typogr.js 技术文档

typogr.js 技术文档

2024-12-24 09:39:31作者:段琳惟

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

4. 项目安装方式

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

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
620
116
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
286
82
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
49
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
61
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
31
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
417
36
vue3-element-adminvue3-element-admin
🔥Vue3 + Vite6+ TypeScript + Element-Plus 构建的后台管理前端模板,配套接口文档和后端源码,vue-element-admin 的 Vue3 版本。
Vue
79
11
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
65
Ffit-framework
FIT: 企业级AI开发框架,提供多语言函数引擎(FIT)、流式编排引擎(WaterFlow)及Java生态的LangChain替代方案(FEL)。原生/Spring双模运行,支持插件热插拔与智能聚散部署,无缝统一大模型与业务系统。
Java
113
13
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
901
0