Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
大白技术控
yanglr2010
提交
ebaf5f4a
Y
yanglr2010
项目概览
大白技术控
/
yanglr2010
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
Y
yanglr2010
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
ebaf5f4a
编写于
8月 24, 2019
作者:
EvanOne(文一)
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: Update docs & README
docs: Update
上级
fc4f6b67
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
55 addition
and
29 deletion
+55
-29
README.md
README.md
+1
-1
README_en_US.md
README_en_US.md
+1
-1
docs/zh-CN/advanced/theme-config.md
docs/zh-CN/advanced/theme-config.md
+53
-27
未找到文件。
README.md
浏览文件 @
ebaf5f4a
...
...
@@ -86,7 +86,7 @@ $ git pull
|
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235410.png"
alt=
"IE"
width=
"32px"
height=
"32px"
/></br>
IE |
<img
src=
"https://cdnjs.cloudflare.com/ajax/libs/browser-logos/35.1.0/edge/edge_64x64.png"
alt=
"Edge"
width=
"32px"
height=
"32px"
/></br>
Edge |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235406.png"
alt=
"Firefox"
width=
"32px"
height=
"32px"
/></br>
Firefox |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235407.png"
alt=
"Chrome"
width=
"32px"
height=
"32px"
/></br>
Chrome |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235409.png"
alt=
"Safari"
width=
"32px"
height=
"32px"
/></br>
Safari |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235411.png"
alt=
"Opera"
width=
"32px"
height=
"32px"
/></br>
Opera |
| :---: | :---: | :---: |:---: | :---: | :---: |
|
9+ | 12+ | 41+ | 42+ | 10+ | 29
+ |
|
Not Supported | 12+ | 41+ | 45+ | 10+ | 32
+ |
## :handshake: 开源协议
...
...
README_en_US.md
浏览文件 @
ebaf5f4a
...
...
@@ -84,7 +84,7 @@ If you have problems, please read [documentation](https://liuyib.github.io/hexo-
|
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235410.png"
alt=
"IE"
width=
"32px"
height=
"32px"
/></br>
IE |
<img
src=
"https://cdnjs.cloudflare.com/ajax/libs/browser-logos/35.1.0/edge/edge_64x64.png"
alt=
"Edge"
width=
"32px"
height=
"32px"
/></br>
Edge |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235406.png"
alt=
"Firefox"
width=
"32px"
height=
"32px"
/></br>
Firefox |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235407.png"
alt=
"Chrome"
width=
"32px"
height=
"32px"
/></br>
Chrome |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235409.png"
alt=
"Safari"
width=
"32px"
height=
"32px"
/></br>
Safari |
<img
src=
"https://raw.githubusercontent.com/liuyib/picBed/master/collection/20190723235411.png"
alt=
"Opera"
width=
"32px"
height=
"32px"
/></br>
Opera |
| :---: | :---: | :---: |:---: | :---: | :---: |
|
9+ | 12+ | 41+ | 42+ | 10+ | 29
+ |
|
Not Supported | 12+ | 41+ | 45+ | 10+ | 32
+ |
## :handshake: License
...
...
docs/zh-CN/advanced/theme-config.md
浏览文件 @
ebaf5f4a
...
...
@@ -5,7 +5,7 @@
-
修改配置文件、安装新的依赖等,都需要重启 hexo 服务器。
-
没有特别说明,配置项默认从
`v1.0.0`
版本开始支持。
-
稳定的配置使用
<Badge
text=
"Stable"
/>
标明,表示基本不会变动。不稳定的配置使用
<Badge
text=
"Beta"
type=
"warn"
/>
标明,表示未来可能会变动甚至删除。目前还不支持的配置使用
<Badge
text=
"Not Support"
type=
"error"
/>
标明。被废弃的配置使用
<Badge
text=
"Deprecated"
type=
"error"
/>
标明。最早开始支持的版本号使用
<Badge
text=
"v x.x.x"
/>
标明。与主题无关的配置项使用
<Badge
text=
"Disrelated"
type=
"warning"
/>
标明。
:::
:::
## 配置文件
...
...
@@ -44,7 +44,9 @@ language: zh-CN # 可选值 zh-CN 或 en-US
## 添加新页面 <Badge text="Stable"/>
Stun 主题内置了三种页面:分类页、标签页、关于页。想启用这些页面,只需要在 Hexo 根目录下执行命令:
Stun 主题内置了三种页面:分类页、标签页、关于页。想启用这些页面,需要按照如下步骤操作:
1.
在 Hexo 根目录下执行命令。
```
bash
# 启用分类页,执行这条指令
...
...
@@ -57,32 +59,44 @@ $ hexo new page tags
$
hexo new page about
```
除了上述三种内置页面外,如果你想使用自定义页面,需要执行如下步骤:
2.
然后修改主题配置文件,将对应的项取消注释。
```
yaml
menu
:
home
:
/ || home
archives
:
/archives/ || folder-open
# categories: /categories/ || th
# tags: /tags/ || tags
# about: /about/ || user
# xxx: /xxx/ || xxx
```
除了使用上述三种内置页面外,如果你想使用自定义页面,需要执行如下步骤:
以添加
**阅读**
页面为例。
1.
修改主题配置文件
1.
修改主题配置文件
,添加相应的菜单项。
```
yaml
menu
:
# 格式如下
# xxx: 路径 || 图标名称
read
:
/read
/ || book
read
ing
:
/reading
/ || book
```
> 图标的名称在这里获取:[https://fontawesome.com/v4.7.0/icons/](https://fontawesome.com/v4.7.0/icons/)。
>
> 如果只添加路径,没有添加图标名称,会使用默认图标进行显示。
2.
创建页面文件
2.
创建页面文件
。
在 Hexo 根目录下执行指令:
```
bash
$
hexo new page
read
$
hexo new page read
ing
```
3.
国际化设置
3.
国际化设置
。
找到
`languages`
目录下的语言文件进行修改:
...
...
@@ -90,14 +104,14 @@ $ hexo new page read
```
yaml
nav
:
read
:
阅读
read
ing
:
阅读
```
`en.yml`
:
```
yaml
nav
:
read
:
Read
read
ing
:
Reading
```
这样就完成了自定义页面的添加。
...
...
@@ -112,11 +126,11 @@ menu_settings:
text_only
:
false
```
## Front-
m
atter
## Front-
M
atter
`Front-
matter`
在 Hexo 主题中,占据了极其重要的地位。如果你还不了解
`Front-matter`
,可以查看这里:
[
https://hexo.io/zh-cn/docs/front-matter
](
https://hexo.io/zh-cn/docs/front-m
atter
)
。
`Front-
Matter`
在 Hexo 主题中,占据了极其重要的地位。如果你还不了解
`Front-Matter`
,可以查看这里:
[
https://hexo.io/zh-cn/docs/Front-Matter
](
https://hexo.io/zh-cn/docs/Front-M
atter
)
。
下面是 Hexo 中默认提供的几种
`Front-
m
atter`
属性。
下面是 Hexo 中默认提供的几种
`Front-
M
atter`
属性。
-
`title`
<Badge
text=
"Stable"
/>
- 标题
-
`date`
<Badge
text=
"Stable"
/>
- 文件建立日期
...
...
@@ -175,11 +189,23 @@ tags:
那么它会被解析为
`foo,bar,baz`
,也就是一个标签。
-
`layout`
<Badge
text=
"Not Support"
type=
"error"
/>
- 布局
-
`layout`
<Badge
text=
"Stable"
/>
- 是否处理 markdown 源文件
如果你不想你的文章或页面被处理,可以将
`Front-Matter`
中的
`layout`
设为
`false`
。例如:
> Stun 主题目前暂时还不支持,最近的版本中考虑进行支持。
设置了
`layout: false`
:
还有几种
`Front-matter`
属性在 Hexo 文档中并没有出现(也许是 Hexo 的文档没有更新吧),但在 Hexo 官方提供的主题开发测试文件中出现。按照测试文件的要求,一个合格的 Hexo 主题都应该支持它们。这些属性如下:
![](
https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190820175118.png
)
> 可以看到,设置了 `layout: false` 后,不对 markdown 文件做任何处理,直接将文件的原始内容显示出来。
没有设置
`layout: false`
的默认情况下或设置了
`layout: true`
:
![](
https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190820175119.png
)
---
下面几种
`Front-Matter`
属性在 Hexo 文档中并没有出现(也许是 Hexo 的文档没有更新吧),但在 Hexo 官方提供的主题开发测试文件中出现。按照测试文件的要求,一个合格的 Hexo 主题都应该支持它们。这些属性如下:
-
`link`
<Badge
text=
"Stable"
/>
<Badge
text=
"v1.1.3"
/>
- 链接
...
...
@@ -200,7 +226,7 @@ photos:
![](
https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190724170139.png
)
为了优化这些图片的显示效果,Stun 主题提供了
**瀑布流布局**
<Badge
text=
"Stable"
/>
<Badge
text=
"v1.1.4"
/>
(
**只对文章中通过 `Front-matter` 的 `photos` 属性指定的图片起作用**
),
修改主题配置文件:
为了优化这些图片的显示效果,Stun 主题提供了
**瀑布流布局**
<Badge
text=
"Stable"
/>
<Badge
text=
"v1.1.4"
/>
,如果想启用这一布局,你需要
修改主题配置文件:
```
yaml
gallery_waterfall
:
...
...
@@ -221,12 +247,12 @@ gallery_waterfall:
::: tip
-
启用瀑布流效果后,还可以再启用
[
fancybox 效果
](
https://liuyib.github.io/hexo-theme-stun/zh-CN/advanced/assist.html#fancybox
)
。
-
通常利用
`photos`
这个属性,来建立一个
**相册页面**
或
**专门展示图片的文章**
。
:::
-
通常利用
`photos`
这个属性,来建立一个
**相册页面**
或
**专门展示图片的文章**
。例如:
[
https://liuyib.github.io/gallery/
](
https://liuyib.github.io/gallery/
)
:::
---
下面是 Stun 主题中,特有的几种
`Front-
m
atter`
属性。
下面是 Stun 主题中,特有的几种
`Front-
M
atter`
属性。
> 这些属性在后面的文档中会有详细说明,这里可以跳过。
...
...
@@ -256,7 +282,7 @@ gallery_waterfall:
---
下面是安装某些插件后,可以设置的几种
`Front-
m
atter`
属性。
下面是安装某些插件后,可以设置的几种
`Front-
M
atter`
属性。
> 这些属性在后面的文档中会有详细说明,这里可以跳过。
...
...
@@ -311,7 +337,7 @@ header:
## 指定顶部图 <Badge text="Stable"/>
如果想要为某个页面或某篇文章单独指定顶部图,你只需要在页面或文章 markdown 源文件的
[
Front-
matter
](
https://hexo.io/zh-cn/docs/front-m
atter
)
中,添加
`top_image`
项,然后填入的图片 url 或路径即可。例如:
如果想要为某个页面或某篇文章单独指定顶部图,你只需要在页面或文章 markdown 源文件的
[
Front-
Matter
](
https://hexo.io/zh-cn/docs/Front-M
atter
)
中,添加
`top_image`
项,然后填入的图片 url 或路径即可。例如:
```yaml
---
...
...
@@ -509,7 +535,7 @@ social_setting:
当你添加一个默认没有的社交链接时,你需要进行国际化设置。这里以添加链接 `掘金` 为例,步骤如下:
1. 修改主题配置文件
1. 修改主题配置文件
。
```
yaml
social:
...
...
@@ -518,7 +544,7 @@ social:
> 由于 Font Awesome 中找不到掘金的 logo,所以这里使用 `掘` 字来代替显示。
2. 国际化
2. 国际化
设置。
修改 `themes/stun/languages` 目录下的文件。
...
...
@@ -557,12 +583,12 @@ toc:
# 是否始终展开所有文章目录。true:始终展开,false:当文章中对应的标题到达顶部时自动展开。
expand_all: false
# 生成目录时,解析 h 标签的最大深度。
# 你可以在文章的 markdown 源文件的 Front-
m
atter 中,通过添加
`toc_max_depth`
属性,
# 你可以在文章的 markdown 源文件的 Front-
M
atter 中,通过添加
`toc_max_depth`
属性,
# 来指定某篇文章生成目录时,解析 h 标签的最大深度。
max_depth: 6
```
其中 `expand_all` <Badge text="v1.0.2"/>。可以在文章的 markdown 源文件中的 `Front-
m
atter` 里,指定 `toc: true / false` 来设置某篇文章是否启用目录。
其中 `expand_all` <Badge text="v1.0.2"/>。可以在文章的 markdown 源文件中的 `Front-
M
atter` 里,指定 `toc: true / false` 来设置某篇文章是否启用目录。
## 订阅设置 <Badge text="Stable"/>
...
...
@@ -768,7 +794,7 @@ $ npm uninstall hexo-generator-index --save
$ npm install hexo-generator-index-pin-top --save
```
最后,在文章的 `Front-
m
atter` 中,使用 `top: true` 来实现置顶。
最后,在文章的 `Front-
M
atter` 中,使用 `top: true` 来实现置顶。
设置文章置顶后,在文章列表中可以看到表示置顶的图标。你可以对图标进行设置,修改主题配置文件:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录