Skip to content

Latest commit

 

History

History
209 lines (159 loc) · 4.59 KB

README.md

File metadata and controls

209 lines (159 loc) · 4.59 KB

Github Pages 使用指南

fork 此仓库

更名为 “[github_user].github.io”，其中 [github_user] 就是你的 github 用户名；

这个仓库的名字 [github_user].github.io 就是访问网站的网址。

网站配置

修改配置文件 _config.yml

网站设置

title   : 我的个人博客
description: > # this means to ignore newlines until "Language & timezone"
  学习笔记 & 存档 & 想法

Github 仓库

## => GitHub Repository (if the site is hosted by GitHub)
##############################
repository: github_user
repository_tree: master

个人信息

## => Author and Social
##############################
author:
  type      : # "person" (default), "organization"
  name      : 我的名字
  ...

Markdown Enhancements 全局设置：

  • 用于渲染 $\LaTeX$ 公式的 mathjax 渲染器
  • mathjax_autoNumber 公式自动编号
  • Mermaid 流程图
  • Chart 交互表格
## => Markdown Enhancements
##############################
## Mathjax
mathjax: # false (default), true
mathjax_autoNumber: # false (default), true

## Mermaid
mermaid: # false (default), true

## Chart
chart: # true false (default), true

Logo 和 Favicon

替换 _includes/svg/logo.svg 来设置你的 Logo。

推荐使用 RealFaviconGenerator 来生成 Favicon。

下载生成的压缩包，用其中的文件

./
├── android-chrome-192x192.png
├── android-chrome-256x256.png
├── apple-touch-icon.png
├── browserconfig.xml
├── favicon-16x16.png
├── favicon-32x32.png
├── favicon.ico
├── mstile-150x150.png
├── safari-pinned-tab.svg
└── site.webmanifest

替换 /assets 文件夹内所有同名文件，并且替换 favicon.ico。

设置作者卡片

设置 _data/variables.yml

show_author_profile: ture

并修改 avatar

## => Author and Social
##############################
author:
  type      : # "person" (default), "organization"
  name      : 我的名字
  url       : 
  avatar    : '/pictures/avatar.png'

撰写博客

将 markdown 文档放置在 _posts/ 文件夹，按照 year-month-date-Tilte 的格式命名，例如：

/_posts/2023-05-10-Beat-Track-Algorithm.md

并且在文档开头做以下声明 layout 和 title

---
layout: article
title: 节拍跟踪算法概述
---

如果需要覆盖全局设置也可以添加内容

---
layout: article
title: 节拍跟踪算法概述
mathjax: true
mathjax_autoNumber: true
---

设置封面

---
layout: article
title: 节拍跟踪算法概述
mathjax: true
article_header:
  type: overlay
  theme: dark
  background_color: '#203028'
  background_image:
    src: /pictures/cover/IMG_1094.jpg
---

插入图片

用户图片存放在 pictures/ 文件夹

插入图片必须采用绝对路径，例如

![](/pictures/example.jpg)

这样才能在 Github Pages 上正确显示。

使用 Google Drive 作为图床

打开 Google Drive，登入账户。选择其中一张图片，右键，选择“共享”，把“常规访问权限”从“受限”改为“知道链接的任何人”，然后点“复制链接”，得到类似这样的链接

https://drive.google.com/file/d/[CODE]/view?usp=sharing

复制 [CODE], 把链接改为

https://drive.google.com/uc?export=view&id=[CODE]

或者

https://drive.google.com/uc?export=download&id=[CODE]

可以作为图片插入文档

插入 PDF

<center><embed src="/assets/example.pdf" width="850" height="600" ></center>

发布

Push 到 [github_user].github.io 仓库

等待几分钟 Github 自动编译即可。

本地部署

在Windows系统上安装Ruby和Jekyll：

  • 安装Ruby: 前往 https://rubyinstaller.org/ 下载 RubyInstaller，并按照安装向导进行安装。在安装过程中，请确保勾选 "Add Ruby executables to your PATH" 选项。
  • 安装Jekyll: 打开命令提示符（Command Prompt）或 PowerShell，并运行以下命令： 
    gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
    gem install jekyll bundler
    bundle install
  • 本地预览 Jekyll 集成了一个开发用的服务器，可以让你使用浏览器在本地进行预览。通过命令启动开发服务器: 
    bundle exec jekyll serve

然后你就可以访问 http://localhost:4000/ 预览你的网站了。

License

基于 TeXt Theme (MIT License)