在 Web 开发中,版权信息是不可或缺的一部分。很多网站都是以 Markdown 编写,然后通过工具将其转化为 HTML 或其他格式。如果我们能够让版权信息让美观、优雅,那么就显得更有趣味了。
typographic-copyright 是一个基于 Node.js 的 npm 包,可以为我们带来更美观的版权声明。本文将详细介绍使用该包的步骤。
安装 typographic-copyright
要使用该包,我们首先要在本地安装 Node.js。进入Node.js 官网下载安装包,安装成功后,在命令行中输入以下命令来检查 Node.js 是否安装成功:
$ node -v v12.16.3
然后就可以在项目的根目录下安装 typographic-copyright:
$ npm install typographic-copyright
使用 typographic-copyright
- 引入 typographic-copyright
在项目的 JS 文件中引入 typographic-copyright:
const Copyright = require('typographic-copyright');
- 创建一个版权声明
首先,我们需要创建一个版权声明变量。这个变量需要传递一个参数,该参数是包含我们想添加版权信息的字符串。
const myCopyright = new Copyright( '版权所有 © 2020(公司名称)。保留所有权利。', );
- 设置版权信息
接着,我们可以通过一些方法来设置版权信息。比如,我们可以将该信息转化为 HTML 标签和纯文本格式:
// 转化为 HTML 标签 console.log(myCopyright.toHTML()); // 转化为纯文本格式 console.log(myCopyright.toText());
这些方法可以让我们自定义样式和排版。
- 添加版权信息到 Markdown 文件中
使用此包,我们可以将版权声明添加到 Markdown 文件中。我们只需使用以下语法:
© 2020(公司名称)。保留所有权利。
它将会被自动转化为 HTML 标签:
<p><span class="symbol">©</span> 2020(公司名称)。保留所有权利。</p>
如果我们想将样式设置为自己想要的样式,我们可以使用以下语法:
© 2020(公司名称)。保留所有权利. { class=‘my-custom-class’ }
该语法将会根据我们想要的样式添加 class。
示例
以下是一个例子,在 GitHub 和 Blog 上添加版权声明:
© 2020 My Company. All rights reserved.
以上字符串将会被包装为 HTML 标签:
<p><span class="symbol">©</span> 2020 My Company. All rights reserved.</p>
下面是一个完整的示例代码:
-- -------------------- ---- ------- ----- --------- - --------------------------------- ----- --------- - --- --------- ----- ---- - --- --------------------- ----- -------------- - - - -- ------- ------- --- --- ---- - ------- ------------- --- ------ --------- -- ----- ------------ - - --- ------ -- ------- ---- ----- ----- --------------------- ------- -- -------- --- --- ---- --- - ------- ------------- --- ------ --------- -- --------------- ----------------------------------- --------------- ---------------------------------展开代码
以上代码将在 GitHub 和 Blog 上输出 Markdown 中的 HTML。为了使我们的版权声明更加优雅而不是在所有地方都是一样的,我们可以根据具体情况做出一些修改。
在 GitHub 上,我们可以使用 CSS 来为版权声明添加样式。
.symbol { color: #0366d6; font-size: 1.2em; font-family: sans-serif; vertical-align: text-bottom; }
总结
在 Web 开发中,版权信息是必不可少的。通过使用 Node.js 的 typographic-copyright,我们可以更加优雅地添加版权信息。
该包提供了多个方法,使我们可以为版权信息设置样式,并将其添加到 Markdown 文件中。这对于那些还在学习 Web 开发的人来说将会是一个很好的指导。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/73586