hexo _config.yml站点配置文件说明

快来打我* 2022-11-05 13:53 7阅读 0赞

## site ##

*  title: 网站标题  
    subtitle: ‘网站说明1’  
    description: ‘网站说明2’  
    keywords:  
    author: 作者名  
    language: zh-Hans  
    timezone: ’ ’

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>title</code></td> 
   <td align="left">网站标题</td> 
  </tr> 
  <tr> 
   <td align="left"><code>subtitle</code></td> 
   <td align="left">网站副标题</td> 
  </tr> 
  <tr> 
   <td align="left"><code>description</code></td> 
   <td align="left">网站描述</td> 
  </tr> 
  <tr> 
   <td align="left"><code>keywords</code></td> 
   <td align="left">网站的关键词。使用半角逗号 <code>,</code> 分隔多个关键词。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>author</code></td> 
   <td align="left">您的名字</td> 
  </tr> 
  <tr> 
   <td align="left"><code>language</code></td> 
   <td align="left">网站使用的语言。对于简体中文用户来说，使用不同的主题可能需要设置成不同的值，请参考你的主题的文档自行设置，常见的有 <code>zh-Hans</code>和 <code>zh-CN</code>。</td> 
  </tr> 
  <tr> 
   <td align="left"><code>timezone</code></td> 
   <td align="left">网站时区。Hexo 默认使用您电脑的时区。请参考 <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" rel="nofollow">时区列表</a> 进行设置，如 <code>America/New_York</code>, <code>Japan</code>, 和 <code>UTC</code> 。一般的，对于中国大陆地区可以使用 <code>Asia/Shanghai</code>。</td> 
  </tr> 
 </tbody> 
</table>

其中，`description`主要用于SEO，告诉搜索引擎一个关于您站点的简单描述，通常建议在其中包含您网站的关键词。`author`参数用于主题显示文章的作者。

## URL ##

*  url: https://账户名.github.io  
    root: /  
    permalink: :year/:month/:day/:title/  
    permalink\_defaults:  
    pretty\_urls:  
    trailing\_index: true  
    trailing\_html: true

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>url</code></td> 
   <td align="left">网址</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td align="left"><code>root</code></td> 
   <td align="left">网站根目录</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td align="left"><code>permalink</code></td> 
   <td align="left">文章的 <a href="https://hexo.io/zh-cn/docs/permalinks" rel="nofollow">永久链接</a> 格式</td> 
   <td><code>:year/:month/:day/:title/</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>permalink_defaults</code></td> 
   <td align="left">永久链接中各部分的默认值</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td align="left"><code>pretty_urls</code></td> 
   <td align="left">改写 <a href="https://hexo.io/zh-cn/docs/variables" rel="nofollow"><code>permalink</code></a> 的值来美化 URL</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td align="left"><code>pretty_urls.trailing_index</code></td> 
   <td align="left">是否在永久链接中保留尾部的 <code>index.html</code>，设置为 <code>false</code> 时去除</td> 
   <td><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>pretty_urls.trailing_html</code></td> 
   <td align="left">是否在永久链接中保留尾部的 <code>.html</code>, 设置为 <code>false</code> 时去除 (<em>对尾部的 <code>index.html</code>无效</em>)</td> 
   <td><code>true</code></td> 
  </tr> 
 </tbody> 
</table>

**提示：网站存放在子目录，这个情况要注意！！！**

*  如果您的网站存放在子目录中，例如 `http://yoursite.com/blog`，则请将您的 `url` 设为 `http://yoursite.com/blog` 并把 `root` 设为 `/blog/`。
 *  一般的
    
    url: https://账户名.github.io  
    root: /
    
    deploy:
    
    type: git
    
    repository: https://github.com/账户名/账户名.github.io.git
    
    branch: master
    
    （github仓库里面新建一个账户名.github.io的文件夹）
 *  提示中的情况
    
    url: https://账户名.github.io/blog/ (blog是github仓库新建的文件夹)  
    root: /blog
    
    deploy:
    
    type: git
    
    repository: https://github.com/账户名/blog.git
    
    branch: master
    
    （github仓库里面新建一个blog的文件夹）
 *  补充

# 比如，一个页面的永久链接是 http://example.com/foo/bar/index.html
    pretty_urls:
      trailing_index: false
    # 此时页面的永久链接会变为 http://example.com/foo/bar/

## 目录 ##

*  source\_dir: source
    
    public\_dir: public
    
    tag\_dir: tags
    
    archive\_dir: archives
    
    category\_dir: categories
    
    code\_dir: downloads/code
    
    i18n\_dir: :lang
    
    skip\_render:

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th align="left">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>source_dir</code></td> 
   <td align="left">资源文件夹，这个文件夹用来存放内容。</td> 
   <td align="left"><code>source</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>public_dir</code></td> 
   <td align="left">公共文件夹，这个文件夹用于存放生成的站点文件。</td> 
   <td align="left"><code>public</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>tag_dir</code></td> 
   <td align="left">标签文件夹</td> 
   <td align="left"><code>tags</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>archive_dir</code></td> 
   <td align="left">归档文件夹</td> 
   <td align="left"><code>archives</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>category_dir</code></td> 
   <td align="left">分类文件夹</td> 
   <td align="left"><code>categories</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>code_dir</code></td> 
   <td align="left">Include code 文件夹，<code>source_dir</code> 下的子目录</td> 
   <td align="left"><code>downloads/code</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>i18n_dir</code></td> 
   <td align="left">国际化（i18n）文件夹</td> 
   <td align="left"><code>:lang</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>skip_render</code></td> 
   <td align="left">跳过指定文件的渲染。匹配到的文件将会被不做改动地复制到 <code>public</code> 目录中。您可使用 <a href="https://github.com/micromatch/micromatch#extended-globbing" rel="nofollow">glob 表达式</a>来匹配路径。</td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

例如：

skip_render: "mypage/**/*"
    # 将会直接将 `source/mypage/index.html` 和 `source/mypage/code.js` 不做改动地输出到 'public' 目录
    # 你也可以用这种方法来跳过对指定文章文件的渲染
    skip_render: "_posts/test-post.md"
    # 这将会忽略对 'test-post.md' 的渲染

> 提示
> 
> 如果您刚刚开始接触 Hexo，通常没有必要修改这一部分的值。

## 文章 ##

*  new\_post\_name: :title.md \# File name of new posts
    
    default\_layout: post
    
    titlecase: false \# Transform title into titlecase
    
    external\_link:
    
    enable: true \# Open external links in new tab
    
    field: site \# Apply to the whole site
    
    exclude: ‘’
    
    filename\_case: 0
    
    render\_drafts: false
    
    post\_asset\_folder: false
    
    relative\_link: false
    
    future: true
    
    highlight:
    
    enable: true
    
    line\_number: true
    
    auto\_detect: false
    
    tab\_replace: ‘’
    
    wrap: true
    
    hljs: false

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th align="left">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>new_post_name</code></td> 
   <td align="left">新文章的文件名称</td> 
   <td align="left">:title.md</td> 
  </tr> 
  <tr> 
   <td align="left"><code>default_layout</code></td> 
   <td align="left">预设布局</td> 
   <td align="left">post</td> 
  </tr> 
  <tr> 
   <td align="left"><code>auto_spacing</code></td> 
   <td align="left">在中文和英文之间加入空格</td> 
   <td align="left">false</td> 
  </tr> 
  <tr> 
   <td align="left"><code>titlecase</code></td> 
   <td align="left">把标题转换为 title case</td> 
   <td align="left">false</td> 
  </tr> 
  <tr> 
   <td align="left"><code>external_link</code></td> 
   <td align="left">在新标签中打开链接</td> 
   <td align="left">true</td> 
  </tr> 
  <tr> 
   <td align="left"><code>external_link.enable</code></td> 
   <td align="left">在新标签中打开链接</td> 
   <td align="left"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>external_link.field</code></td> 
   <td align="left">对整个网站（<code>site</code>）生效或仅对文章（<code>post</code>）生效</td> 
   <td align="left"><code>site</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>external_link.exclude</code></td> 
   <td align="left">需要排除的域名。主域名和子域名如 <code>www</code> 需分别配置</td> 
   <td align="left"><code>[]</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>filename_case</code></td> 
   <td align="left">把文件名称转换为 (1) 小写或 (2) 大写</td> 
   <td align="left">0</td> 
  </tr> 
  <tr> 
   <td align="left"><code>render_drafts</code></td> 
   <td align="left">显示草稿</td> 
   <td align="left">false</td> 
  </tr> 
  <tr> 
   <td align="left"><code>post_asset_folder</code></td> 
   <td align="left">启动 <a href="https://hexo.io/zh-cn/docs/asset-folders" rel="nofollow">Asset 文件夹</a></td> 
   <td align="left">false</td> 
  </tr> 
  <tr> 
   <td align="left"><code>relative_link</code></td> 
   <td align="left">把链接改为与根目录的相对位址</td> 
   <td align="left">false</td> 
  </tr> 
  <tr> 
   <td align="left"><code>future</code></td> 
   <td align="left">显示未来的文章</td> 
   <td align="left">true</td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight</code></td> 
   <td align="left">代码块的设置</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.enable</code></td> 
   <td align="left">开启代码块高亮</td> 
   <td align="left"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.auto_detect</code></td> 
   <td align="left">如果未指定语言，则启用自动检测</td> 
   <td align="left"><code>false</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.line_number</code></td> 
   <td align="left">显示行数 <em>Enabling this option will also enable <code>wrap</code> option</em></td> 
   <td align="left"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.tab_replace</code></td> 
   <td align="left">用 n 个空格替换 tabs；如果值为空，则不会替换 tabs</td> 
   <td align="left"><code>''</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.wrap</code></td> 
   <td align="left">Wrap the code block in <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table" rel="nofollow">``</a></td> 
   <td align="left"><code>true</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>highlight.hljs</code></td> 
   <td align="left">Use the <code>hljs-*</code> prefix for CSS classes</td> 
   <td align="left"><code>false</code></td> 
  </tr> 
 </tbody> 
</table>

> 相对地址
> 
> 默认情况下，Hexo 生成的超链接都是绝对地址。例如，如果您的网站域名为 `example.com`,您有一篇文章名为 `hello`，那么绝对链接可能像这样：`http://example.com/hello.html`，它是**绝对**于域名的。相对链接像这样：`/hello.html`，也就是说，无论用什么域名访问该站点，都没有关系，这在进行反向代理时可能用到。通常情况下，建议使用绝对地址。

## 其他 ##

## 分类 & 标签 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th align="left">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>default_category</code></td> 
   <td align="left">默认分类</td> 
   <td align="left"><code>uncategorized</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>category_map</code></td> 
   <td align="left">分类别名</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left"><code>tag_map</code></td> 
   <td align="left">标签别名</td> 
   <td align="left"></td> 
  </tr> 
 </tbody> 
</table>

## 日期 / 时间格式 ##

Hexo 使用 [Moment.js][] 来解析和显示时间。

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th align="left">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>date_format</code></td> 
   <td align="left">日期格式</td> 
   <td align="left"><code>YYYY-MM-DD</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>time_format</code></td> 
   <td align="left">时间格式</td> 
   <td align="left"><code>HH:mm:ss</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>use_date_for_updated</code></td> 
   <td align="left">启用以后，如果 Front Matter 中没有指定 <code>updated</code>， <a href="https://hexo.io/zh-cn/docs/variables#%E9%A1%B5%E9%9D%A2%E5%8F%98%E9%87%8F" rel="nofollow"><code>post.updated</code></a> 将会使用 <code>date</code> 的值而不是文件的创建时间。在 Git 工作流中这个选项会很有用</td> 
   <td align="left"><code>true</code></td> 
  </tr> 
 </tbody> 
</table>

## 分页 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
   <th align="left">默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>per_page</code></td> 
   <td align="left">每页显示的文章量 (0 = 关闭分页功能)</td> 
   <td align="left"><code>10</code></td> 
  </tr> 
  <tr> 
   <td align="left"><code>pagination_dir</code></td> 
   <td align="left">分页目录</td> 
   <td align="left"><code>page</code></td> 
  </tr> 
 </tbody> 
</table>

## 扩展 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">参数</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>theme</code></td> 
   <td align="left">当前主题名称。值为<code>false</code>时禁用主题</td> 
  </tr> 
  <tr> 
   <td align="left"><code>theme_config</code></td> 
   <td align="left">主题的配置文件。在这里放置的配置会覆盖主题目录下的 <code>_config.yml</code> 中的配置</td> 
  </tr> 
  <tr> 
   <td align="left"><code>deploy</code></td> 
   <td align="left">部署部分的设置</td> 
  </tr> 
  <tr> 
   <td align="left"><code>meta_generator</code></td> 
   <td align="left"><a href="https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/meta#%E5%B1%9E%E6%80%A7" rel="nofollow">Meta generator</a> 标签。 值为 <code>false</code> 时 Hexo 不会在头部插入该标签</td> 
  </tr> 
 </tbody> 
</table>

[Moment.js]: http://momentjs.com/