Nanoc 静态站点生成器技术文档

1. 安装指南

环境要求

• Ruby (推荐版本：2.7.x 或更高版本)
• Bundler

安装步骤

1. 确保已经安装了Ruby和Gem。如果没有安装，请访问Ruby官方网站下载并安装。

2. 打开命令行，运行以下命令安装Nanoc：

   gem install nanoc
   

3. 确保安装了Bundler。如果没有安装，可以通过以下命令安装：

   gem install bundler
   

4. 创建一个新的Nanoc项目，运行以下命令：

   nanoc new-site
   

5. 进入项目目录，安装项目依赖：

   cd your_nanoc_project
   bundle install
   

6. 运行以下命令启动Nanoc服务器：

   nanoc server
   

7. 在浏览器中访问 http://localhost:3000，查看Nanoc项目。

2. 项目的使用说明

Nanoc是一款基于Ruby的灵活静态站点生成器。以下是Nanoc的基本使用方法：

创建新文章

在 content 文件夹中创建新的Markdown文件，例如 index.md。文件内容如下：

---
title: "欢迎"
author: "你的名字"
date: "2023-11-01"
---

欢迎来到我的Nanoc站点！

这里是站点的首页，你可以在这里添加你的文章内容。

编译站点

在项目目录中，运行以下命令编译站点：

nanoc

预览站点

在项目目录中，运行以下命令启动Nanoc服务器：

nanoc server

在浏览器中访问 http://localhost:3000，查看编译后的站点。

3. 项目API使用文档

Nanoc API文档提供了关于如何使用Nanoc类库的详细信息。以下是一些基本的API使用示例：

创建自定义过滤器

可以通过继承 Nanoc::Filter 类来创建自定义过滤器。

require 'nanoc'

class MyCustomFilter < Nanoc::Filter
  def run(content)
    # 自定义处理逻辑
    content.gsub(/Hello/, '你好')
  end
end

使用自定义过滤器

在你的Nanoc项目中，可以通过以下方式使用自定义过滤器：

rule '/*.html' do
  filter :my_custom_filter
end

4. 项目安装方式

如前所述，Nanoc可以通过Ruby的Gem包进行安装。以下是安装步骤：

1. 确保已经安装了Ruby和Gem。

2. 打开命令行，运行以下命令安装Nanoc：

   gem install nanoc
   

3. 创建一个新的Nanoc项目，运行以下命令：

   nanoc new-site
   

4. 进入项目目录，安装项目依赖：

   cd your_nanoc_project
   bundle install
   

5. 运行以下命令启动Nanoc服务器：

   nanoc server
   

以上就是关于Nanoc静态站点生成器的技术文档，希望对您有所帮助。