BIT Lecture

• 上网不涉密 涉密不上网
• 编辑注意事项
  • 基本操作
  • 作者添加 - 签约成为马猴烧酒
• 投稿&编辑细则
  • 命名
  • 头部标识
  • 内容
  • 提交
• 改动说明
• 目录说明
  • _layout
  • include

Under construction.

Any suggestions mail to our public email

长期征收投稿，直接投稿至邮箱即可。

上网不涉密 涉密不上网

请注意，投稿内容仅限于课程，请勿夹带私货，谨记第二校训，上网不涉密，涉密不上网。

编辑注意事项

基本操作

对于有push权限的各位编辑，以Windows为例，推荐采用GitHub Desktop对repo进行clone，然后使用自己喜欢的编辑器进行修改。推荐Markdown编辑器为Typora，推荐代码编辑器为VS Code。

由于大多数人不具备编辑基础，因此不推荐修改已有代码，而是建议仅对.\_posts\下的投稿进行修改。

作者添加 - 签约成为马猴烧酒

当有作者加入时，需要首先在\_data\authors.yml中增加作者记录。

Shicong Liu:
  name        : "Shicong Liu"
  bio         : "-"
  avatar      : "/assets/images/Shostakovich.jpg"
  links:
    - label: "Email"
      icon: "fas fa-fw fa-envelope-square"
      url: "mailto:prophet1380@gmail.com"
    - label: "Website"
      icon: "fas fa-fw fa-link"
      url: "https://psycholsc.github.io"

以我本人为例，在后面直接加入这样一段即可。注意最外层的名字要求实名，里面的署名可以自定义，bio这里可以自由发挥。头像按照说明放在指定位置，并在这里标出即可。后面的links还可以加很多东西，可以参考官方文档进行添加。

添加了作者之后就可以在提交作品中进行署名啦。

投稿&编辑细则

投稿接受任意可编辑文件。

作者请直接提交到公共邮箱

命名

投稿文件位置为.\_posts\，所有投稿文件按照规则命名

YYYY-MM-DD-Title.md

其中标题Title的空格也全部使用-填充。扩展名也可以是markdown。

---

头部标识

投稿文件需要指定的头部标识，典型的头部标识可以写作如下形式

---
title:  "title"
excerpt: "excerpt"
date:   2019-6-20 15:31:47 +0000
categories: Notes
tags: 
  - "数字图像处理"
  - "傅里叶变换"
  - "滤波"
  - "卷积神经网络"
comments: true
header:
  image: assets/images/lenax3.png
#   caption: "Photo credit: [**Unsplash**](https://unsplash.com)"
toc: true
toc_label: "Table of Contents"
toc_icon: "cog"
author: Shicong Liu
coauthor: xxx
---

以上是yaml表示，标题和副标题可以填写与实际相符的内容，时间正确填写，后面的comments还没有开放，可以先不填（不写这一项）。

catagories可以提供一个分类方式，如上所述描述为Notes，大家此阶段可以自由添加，后面的tags是同理的。今后在文章足够多的时候才会进行门类与标签的规范化。

后面的header条目是编辑文章头部的内容，此处只添加了图像，图像可以添加引用来源caption。推荐采用3:1比例的图像。

toc是侧边导航栏，默认关闭，在这里手动开启，可选图标icon直接参考官方文档即可。如果希望将内容扩展到右侧的区域（这时导航栏将嵌入到主体中），则选择添加以下条目。

classes:  wide

关于作者，需要在\_data\authors.yml中添加作者信息。每一位投稿人都可以根据个人信息进行填写，并且如上方式添加author即可在页面左侧看到作者的自定义信息。注意作者的头像信息需要放在\assets\images\下，并且在信息中对应。这里推荐采用正方形或近似正方形，主要内容集中在中心圆形内的头像，否则可能显示不全。

注意现在已经可以添加合作作者了，只需要在toc中增加一个coauthor条目，规则与author相同，目前限制合作作者数量为1，如果日后存在需求则还会补充。

---

内容

以上是关于文件头部的规则，关于内容，规则如下

1. 在文件开始处不需要使用一级标题再叙述一遍title，因为默认会将title设置为一级标题显示出来。

2. layout实际上是本页面功能的模板，有default, archive, home, posts等。不同的模板作用不同。

3. 当一篇文章存在多个作者的时候，可以采用sidebar方法进行配置，例如

    sidebar:
      - title: "Role"
        image: http://placehold.it/350x250
        image_alt: "logo"
        text: "Designer, Front-End Developer"
      - title: "Responsibilities"
        text: "Reuters try PR stupid commenters should isn't a business model"

   sidebar方法支持的特性还很多，author就是使用sidebar组合出的一种形式，具体使用可以查看官方文档。

4. 内容中出现并列图像时可以使用gallery方法，例如

    gallery:
      - url: /assets/images/unsplash-gallery-image-1.jpg
        image_path: assets/images/unsplash-gallery-image-1-th.jpg
        alt: "placeholder image 1"
      - url: /assets/images/unsplash-gallery-image-2.jpg
        image_path: assets/images/unsplash-gallery-image-2-th.jpg
        alt: "placeholder image 2"
      - url: /assets/images/unsplash-gallery-image-3.jpg
        image_path: assets/images/unsplash-gallery-image-3-th.jpg
        alt: "placeholder image 3"

   这时就定义了一个gallery，使用时可以

    {% include gallery caption="This is a sample gallery to go along with this case study." %}

   就可以在合适的位置进行插入。caption是下方注释标签。

5. 内联公式推荐采用换行的形式，不建议采用行内公式书写长表达式，换行形式输入可以避免一些bug，也会让公式形式更为美观。具体可以参考前面编辑后的文章。另外如果有人对插入公式的latex表达不够熟悉，可以参考此网页

   作为补充，下面给出插入公式时的一个demo

   $$
   \begin{equation}
   \begin{split}
   \left\| x \right\|_p=\left( \sum\limits_{i=1}^n \mid x \mid^p \right)^{\frac 1 p}
   \end{split}
   \tag{0}
   \end{equation}
   $$

   插入效果为 $$ \begin{equation} \begin{split} \left| x \right|p=\left( \sum\limits{i=1}^n \mid x \mid^p \right)^{\frac 1 p} \end{split} \tag{0} \end{equation} $$ 其中中间一行是公式主体，tag可以给公式标号。

6. 图像插入的demo如下

   <div style="text-align:center" title="fig.1"><img alt="fig.1" src="https://raw.githubusercontent.com/psycholsc/psycholsc.github.io/master/assets/cstitle.png" style="display: inline-block;" width="400" />
   <p>Fig.0 CS Abstract </p>
   </div>

   插入效果为

   

   Fig.0 CS Abstract

   直接采用html方法置入，src是图像的位置，width描述插入图像的宽度，style给出的效果是居中。下面可以采用一个简单的标签描述图像的内容。

7. 如果对LaTeX不熟悉，建议去此网页学习一下不同符号如何在LaTeX中表示

8. 在书写英文内容时注意使用半角符号。

9. 还有很多注意事项暂时还来不及写完

投稿中的一些新特性方法会在这里逐渐更新，希望投稿或编辑之前先查看近期的更新情况。

提交

这里只要将本地库push上去就好了，但是要记得把push的内容做好注释，尽量标记好时间，例如搜狗拼音输入法的标准时间格式2019-6-20 22:12:17

改动说明

• 增加返回顶部按钮（参考了codepen）

  直接在assets/js/main.min.js中加入了返回顶部的js，css部分在include/head/custom.html中添加。

  TODO：将.js文件放在js/下单独引用

• 在custom.html中添加使用$ $的代码，以后编辑post无需在前面增加。

• 增加评论功能（选择gitalk，利用项目的issue功能），config配置在最后comments部分，comments的div放在了single.html的文章内容部分（具体位置见注释）。

目录说明

_layout

• default: 默认的layout，其他层通过layout: default继承default

  

• archive: 用来罗列各个类别的文章，包含了上面的sidebar（按照category分类？）

  

• home: 如下所示

  

• single：每篇post的内容布局

include

• archive-single: 在页面里显示单个post的介绍