handsome_typecho docs 1.0

master
ihewro 7 years ago
commit 5b5856185f
  1. 0
      .nojekyll
  2. 10
      _coverpage.md
  3. 13
      _sidebar.md
  4. 16
      comment.md
  5. 40
      common-problem.md
  6. 33
      functions.md
  7. 28
      index.html
  8. 10
      others.md
  9. 33
      page.md
  10. 37
      plugin.md
  11. 6
      setting.md
  12. 23
      start.md

@ -0,0 +1,10 @@
# handsome <small>2.1</small>
> A magical documentation site generator.
[GitHub](https://github.com/ihewro/typecho-theme-handsome)
[Get Started](?id=安装)

@ -0,0 +1,13 @@
- 开始使用
- [安装与更新](/start)
- [后台外观设置](/setting)
- [插件设置](/plugin)
- [常见问题](/common-problem)
- 进阶设定
- [独立页面](/page)
- [评论系统](/comment)
- [增强功能](/functions)
- [其他说明](/others)

@ -0,0 +1,16 @@
主题内置原生评论系统,同样支持任何第三方评论服务(如:多说,disqus,畅言等)。
1. **使用Typecho 原生评论系统**
* 若要启用 PJAX, 你需要关闭`设置->评论->检查评论来源页 URL 是否与文章链接一致选项。`
* 如果仍然无法评论,在后台的设置——评论中关闭检查评论来源页 URL选项。
![使用typecho原生评论][1]
[1]: https://www.ihewro.com/usr/uploads/2017/03/343938553.jpg
2. **使用第三方评论系统**
在主题的——编辑当前外观——comments.php 删掉里面所有内容,增加第三方评论系统的代码。

@ -0,0 +1,40 @@
> Q:**安装完主题后,页面错乱**
A:依次检查主题文件夹名称是否为`handsome`——是否已经安装并且启用主题必要的插件
---
> Q:**评论区不能斗图不能显示图片/说说不能显示图片**
A:后台 `设置——评论——允许使用的HTML标签和属性` 里面添加html标签
```html
<img src="">
```
---
> Q:**评论区无法使用markdown语法?**
A:后台 `设置——评论——在评论中使用Markdown语法(选中)`
后台 `设置——评论——允许使用的HTML标签和属性` 里面添加html标签
```html
<blockquote><pre><code><strong><em><h5><h6><a href title><table><thead><tr><th><tbody><td>
```
---
> Q:**使用Aplayer播放器插件报错?**
A:这儿有解决方法:[issues #5](https://github.com/ihewro/typecho-theme-handsome/issues/5)
---
> Q:**启用主题后,无法评论???**
A:别着急,放轻松。点一下这个链接:[#评论系统](https://www.ihewro.com/archives/645/)
---
> Q:**links插件无法启用?显示500错误?**
A:links插件不是由我维护的,开发作者已经很久没有更新,很可能不能适用你的服务器上面(很可能没有正确的配置服务器)。如果有错误,请在typecho根目录下的`config.inc.php`里加入
```php
define('__TYPECHO_DEBUG__', true);
```
此举会输出详细的错误信息。把具体的错误信息复制,在评论区域或者发邮件给我,这样方便我更快的处理。
---

@ -0,0 +1,33 @@
### 博文头图
指的是**首页**、**文章页面**每篇文章顶部的图片,后台可以设置显示头图的方式。默认显示的顺序是:thumb(自定义字段)--> 第一个图片附件--> 文章第一张图片 --> 随机图片
thumb自定义字段在每篇文章底下填写。名称填:`thumb`,值
* 填图片地址:显示当前图片地址的图片
* 填`no`:则在首页和文章页面同时不显示当前文章的头图
### 文章目录树
文章中的目录树已经内置代码,**仅当文章有h2 h3 h4标题** 才会生成目录树,并且手机端不显示目录树。
**注意**:如果文章中没有`h2`标题,只有`h3 h4`标题是不会生成目录树的。
### 评论表情功能
表情图片存放在主题目录的Img/emoticon 文件夹下。默认12张图片。如果需要更改,则需要同步更改js/OwO.json `斗图`栏目的图片地址。
表情的颜文字和斗图的图片都是以json格式存储并调用的,所以修改需要对json有简单的了解即可。
### 短代码高亮文本
** \* 2.1.0及以上版本新增功能**
<div class="share">这是灰色的短代码框,常用来引用资料什么的,调用代码为 <strong>&lt;div class="share"&gt;输入文字&lt;/div&gt;</strong><br><br></div>
<div class="yellow">这是黄色的短代码框,常用来做提示,引起读者注意。调用代码为 <strong>&lt;div class="yellow"&gt;输入文字&lt;/div&gt;</strong><br><br></div>
<div class="red">这是红色的短代码框,用于严重警告什么的。调用代码为 <strong>&lt;div class="red"&gt;输入文字&lt;/div&gt;</strong><br><br></div>
<div class="lblue">这是浅蓝色的短代码框,用于显示一些信息。调用代码为 <strong>&lt;div class="lblue"&gt;输入文字&lt;/div&gt;</strong><br><br></div>
<div class="green">这是绿色的短代码框,显示一些推荐信息。调用代码为 <strong>&lt;div class="green"&gt;输入文字&lt;/div&gt;</strong><br><br></div>

@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
<div id="app">加载中……</div>
</body>
<script>
window.$docsify = {
homepage: 'start.md',
name: '',
repo: '',
coverpage: true,
subMaxLevel: 9999,
name: 'handsome',
loadSidebar: true
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
</html>

@ -0,0 +1,10 @@
### 首页文章摘要
默认显示文章的前200字作为摘要,你还可以使用`摘要分隔符`进行自主截断内容输出
```markdown
<!--more-->
```
### 侧边栏的标签云
需要在新建文章的页面右侧填写标签,才会在首页侧边栏输出的。(回车添加当前标签)

@ -0,0 +1,33 @@
主题内置了**五套自定义模板** `时光机`、`文章归档`、`友情链接`和`留言板`和`豆瓣书单`。
### 独立页面的使用方法
![2.jpg][1]
在后台了**撰写——创建页面**的右下角的`自定义模板`选择相应的自定义模板即可。下面简单介绍自定义模板的使用方法。
### 时光机
填写地址的时候,必须填写为 <span style="color: rgb(255, 255, 255); background-color: rgb(250, 192, 143);">cross</span>.html 。内容框里面不用填任何东西,这个页面在前台就可以发布“说说”,用来记录你的日常和心情的~
**关于删除说说:**在后台的评论管理中删掉该页面的对应评论即可。
### 文章归档
地址随意填写。内容框不用填任何内容。这个页面会自动把你所有文章以时间树的形式显示出来。
### 友情链接
地址随意填写。这个页面自动输出`links`插件里面设置的友情链接。(具体用法见**插件设置**)友情链接页面的`本博信息`在独立页面的输入框中填写即可,会和链接一起输出。
### 留言板
地址随意填写。这个页面会自动输出评论数最多的前15名。如果需要填写自定义内容在输出框中填写即可,会一起输出。
### 豆瓣书单
地址随意填写。这个页面会自动输出你的豆瓣书单列表。分别为:`正在读的书`,`已读的书`,`想读的书`三个栏目。在自定义字段中填写:名称为`doubanID`,值为`你的豆瓣ID`。**注意:如果你任一一项在`豆瓣读书`为空的话,页面会输出错误!所以要保证每个栏目要有一项数据。**
![3.jpg][2]
[1]: https://www.ihewro.com/usr/uploads/2017/03/3674342886.jpg
[2]: https://www.ihewro.com/usr/uploads/2017/03/2880093812.jpg

@ -0,0 +1,37 @@
**插件使用方法**:下载主题文件夹下面的`插件文件夹`里面的相应插件,并且安装到`\usr\plugins`目录下。
---
handsome v2.1.0及其以上版本的完整使用只依赖了一个外部插件:Links。
该插件如果不使用,不会造成任何页面问题,但是无法使用`友情链接`自定义模板的功能。
**Links**是一个管理友情链接的插件。左侧边栏的`友链`栏目和独立页面中的自定义模板`友情链接`会调用这里面设置的友情链接。
启用该插件后,`后台`——`管理`栏目下会多一个`友情链接`的栏目。
进入后,添加一个链接,只需要填写`链接名称`、`链接地址`、`链接分类`、 `链接描述``自定义数据`这四个项目的内容。
根据**链接分类**填写不同,主题会自动输出到主题的不同位置。
关于`链接分类`的说明:
* `ten`:是全站链接,就是在首页的左侧边栏展示的
* `one`:是内页链接,在独立页面中的自定义模板`友情链接`中显示
* `good`:是推荐链接,在独立页面的自定义模板`友情链接`中显示
**注意:无需填写`链接图片`栏目!!!`自定义数据`栏目填写邮箱地址,会根据邮箱地址自动调用gravatar图片!!**
---
【**注意**】v2.1.0版本以下用户还需要使用以下插件:
> 1.6.0和以上版本使用该插件
TePostViews:使用很简单,在后台插件设置填写对应项即可,有注释说明,可以按照评论数或者浏览数两种方式排序热门文章。
---
> 1.0.0~1.5.x主题使用该插件
BufannaoCms:是用来调用右侧边栏的`热门文章`和`随机文章`这两个功能的。启用后,进入插件设置里面,只需要设置**`随机文章数量`** 和 **`热评文章数量`** 这两项即可。其他项不用设置的。

@ -0,0 +1,6 @@
所有设置都已经有说明文字,这里还是补充几点。
### instantclick预加载模式选择
如果你得服务器配置不好,不建议选择`mouseover`,预加载太多而且配置不好,反而加载页面更慢,更推荐` mousedown`设置。服务器配置好则可以忽略建议。
instantclick更详细文档可以戳这里-->> [instantclick中文文档](https://www.ihewro.com/archives/515/)

@ -0,0 +1,23 @@
### 安装
1. 下载主题文件包并解压后,重命名主题文件夹为`handsome`。
2. 目录下有两个文件夹。`handsome`和`插件`。
3. 上传`插件`下的所有文件夹typecho的`/usr/themes`目录下,上传完毕后可以删除`插件`文件夹。
4. 上传`handsome`文件夹至typecho的`/usr/themes`目录下。
5. 后台启用`handsome`主题。
### 更新
一般有两种方法:
1. 下载后,覆盖`/usr/themes/handsome/`目录即可。
2. 先删除`/usr/themes/handsome/`目录中的内容,然后新主题中的内容复制到`/usr/themes/handsome/`目录。(推荐√)
**\*每次更新会有更新提示,会提示是否有必要删除旧版本的主题文件夹。**
Loading…
Cancel
Save