小白教程

Mr.Hope ... 2021年3月16日 23:57 Get Started 大约 3 分钟

本教程是一个针对小白手把手教程。

# 环境安装

你需要安装最新的 Node.js 长期支持版 和 Yarn。

下载地址:

  • Node.js 长期支持版: 下载地址 (opens new window)

    请点击左侧的绿色按钮。

    在安装过程中,保持所有的默认设置,一路下一步即可。

    注意

    如果你真的是个小白,请不要改默认安装目录,以免你在出现问题时找不到对应的文件夹。

    Node.js 本身只会占据几十 M 的空间!

  • Yarn:

    在安装 Node.js 后,打开终端,执行:

    npm i -g yarn
    
    yarn config set registry https://registry.npm.taobao.org
    
    1
    2
    3

# 创建模板

在一个合适的位置创建一个文件夹,并在该文件夹下打开终端。

对于 Windows 请使用文件管理器打开对应文件夹,之后在上方的地址栏中输入 cmd 之后按下回车。

在终端中执行:

yarn create vuepress-theme-hope docs
1

稍等片刻,你就可以在浏览器地址栏输入 localhost:8080/zh/ 访问开发服务器了。

提示

启动开发服务器,请在终端输入 yarn run docs:dev 并回车。

如果你需要终止开发服务器,请点击终端,并连续两次按下 Ctrl + C

# 添加或修改页面

docs 文件夹下除 .vuepress 文件夹之外的文件都会渲染为网页,渲染后的链接与文件夹结构和文件名称一一对应。只有 readme.md 是特例,它会显示为文件夹下的默认网页 (默认主页)。这应该很好理解。

比如你想要创建一个 /a/b/,你就可以创建 docs/a/b.mddocs/a/b/readme.md,但切记不要同时创建它们两个!

Markdown 的内容会渲染为网页的内容。关于 Markdown 教程,请见 Markdown 教程。大概十五分钟,你就可以学会 Markdown 的内容,看完之后记得回来!

学会 Markdown 之后你就可以尝试自己编辑 Markdown 文件来修改模板的内容。

# 配置 VuePress

学会 Markdown 之后,如果你没有学过 JavaScript 的话,学习它可能有些困难。所以请将配置文件切换为 YAML。

请删除 .vuepress/config.js 并创建 .vuepress/config.yml,复制以下内容并粘贴至该文件中。

# 站点名称
title: Theme Demo
# 站点描述
description: A demo for vuepress-theme-hope
# 输出目录
dest: ./dist
# 使用本主题
theme: hope
# 主题配置
themeConfig:
  # 导航栏图标
  logo: /logo.svg
  # 请设置为你的部署站点
  hostname: https://mister-hope.github.io
  # 请改成你的名字
  author: Mr.Hope
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

你应该学习一些 YAML 的小知识,我们推荐你查看 YAML 教程 (opens new window)

YAML 局限性

使用 YAML 作为配置文件有一定的局限性,比如无法使用加密功能。

如果你希望体验全部的功能,请不要执行以上替换操作,并阅读 JS 快速上手教程 (opens new window)

接下来你就可以阅读本文档 VuePress 基础,大致了解 VuePress 是什么和如何使用它。

如果你觉得已经掌握,接下来就是阅读 VuePress 官方文档 (opens new window) 和本主题文档,根据你想要的对本主题进行配置。

注意

请务必先阅读官方文档再阅读本主题文档。

本主题文档并没有针对官方文档已有的内容做过多的重复介绍,所以如果你不阅读官方文档,你可能无法掌握某些配置,比如模板中使用的多语言。

# 构建网站

在你初步配置好项目之后,你就可以使用 yarn run docs:build 命令将网站构建输出到 dist 文件夹下。

你可以将文件夹的内容部署到你网站的服务器上。最简单的做法是上传到 Github 并开启 Github Pages。

关于 Github 的相关教程,你可以参考 Github 简介 (opens new window)