Hugo Cite 使用教程

Hugo Cite 使用教程

hugo-cite 📝 Easily manage your bibliography and in-text citations with Hugo, the popular static-site generator. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-cite

1. 项目介绍

Hugo Cite 是一个用于在 Hugo 静态网站生成器中轻松管理和引用文献的项目。它提供了简单的短代码（shortcodes）来处理文献引用和参考文献列表，支持 CSL-JSON 格式的文献文件。目前，Hugo Cite 仅支持 APA 引用格式，但未来可能会添加更多格式（欢迎贡献）。

2. 项目快速启动

安装

1. 下载 Hugo Cite： 你可以通过 Git 克隆或下载 ZIP 文件的方式将 Hugo Cite 添加到你的 Hugo 项目中。

   git submodule add https://github.com/loup-brun/hugo-cite.git themes/hugo-cite
   

   项目目录结构应如下所示：

   # 你的 Hugo 项目目录
   ├── config.yml
   └── themes
       └── hugo-cite
   

2. 配置 Hugo 项目： 编辑 Hugo 配置文件 config.yml，在主题参数中添加 hugo-cite。

   theme:
     - <你的主题>
     - hugo-cite
   

3. 添加 CSS： 在你的 HTML 模板中引用 CSS 文件。

   <link rel="stylesheet" type="text/css" href="{{ "/hugo-cite.css" | relURL }}" />
   

使用

1. 提供 CSL-JSON 文献文件： 你需要提供一个 CSL-JSON 格式的文献文件。例如，将其命名为 bibliography.json 并保存在你的 Hugo 项目目录中。

   # 你的 Hugo 项目目录
   ├── content
   │   ├── article1
   │   │   ├── bibliography.json
   │   │   └── index.md
   │   ├── article2
   │   │   ├── image.jpg
   │   │   ├── index.md
   │   │   └── mr-bib.json
   │   └── article3
   │       ├── index.md
   │       └── oh-my-bib.json
   └── path
       └── to
           └── bibliography.json
   

2. 使用短代码：

   • 显示参考文献列表：

     [[< bibliography >]]
     

   • 引用文献：

     [[< cite "Lessig 2002" >]]
     

3. 应用案例和最佳实践

案例1：学术博客

在学术博客中，你可以使用 Hugo Cite 来引用学术论文和书籍。例如，在一篇关于编程哲学的文章中引用 Lawrence Lessig 的著作：

我们的时代有一位哲学家，他不是艺术家，也不是职业作家，他是一位程序员。[[< cite "Lessig 2002" >]]

案例2：技术文档

在技术文档中，你可以引用相关的技术论文或书籍。例如，在一篇关于 DevOps 的文章中引用相关的文献：

DevOps 的概念最早由 Patrick Debois 在 2009 年提出。[[< cite "Debois 2009" >]]

4. 典型生态项目

Zotero

Zotero 是一个开源的文献管理工具，支持导出 CSL-JSON 格式的文献文件。你可以使用 Zotero 来管理和导出文献，然后使用 Hugo Cite 在 Hugo 项目中引用这些文献。

Hugo Themes

Hugo 有丰富的主题生态，你可以选择一个适合你需求的主题，并结合 Hugo Cite 来增强文献引用功能。例如，你可以选择一个支持学术写作的主题，并使用 Hugo Cite 来管理参考文献。

通过这些步骤和案例，你可以轻松地在 Hugo 项目中管理和引用文献，提升内容的专业性和可信度。

hugo-cite 📝 Easily manage your bibliography and in-text citations with Hugo, the popular static-site generator. 项目地址: https://gitcode.com/gh_mirrors/hu/hugo-cite