3分钟速通PaperTheme

PaperTheme
PaperTheme 说明文档

下载

打开命令行,运行

git clone https://github.com/IsTarrie/PaperTheme.git

如果报错,请前往 https://git-scm.com/ 安装git,然后回来重试

安装依赖

刚才的命令行窗口不要关掉,运行

cd PaperTheme

然后运行

npm install

这一步可能会出错,不过基本上只有两个原因

  • 如果你还没有安装npm,请前往 https://nodejs.org/ 安装node.js,然后回来重试
  • 如果你已经安装了,但是还是看到可怕的报错,不要慌,这大概率是权限问题,我自己也遇到不止一次了,解决方法也很简单,直接输入
sudo npm install

这个命令需要管理员权限,所以要输入密码,不用担心,密码不会泄露,等待进度条跑到底,然后就可以进行下一步了

主题配置

先打开PaperTheme的项目文件夹,

基础配置

找到 PaperTheme/src/config/theme.yml,里面的配置信息自己体会,应该不难理解,哪个单词看不明白去问AI,或者直接把整份文件扔给AI让它分析也行.

⚠️注意!!!!你会在PaperTheme的文件夹里面看到很多*.ts文件,不要去动它们!否则PaperTheme可能无法正常运行!!!!

这里给个提示,你向theme.yml里输入的文件最好放在PaperTheme/public/目录下,这样管理起来方便.

添加文章

好了,配置完了吧,那我们开始写文章

把你的目光移到PaperTheme/content/目录下,

⚠️注意!!!!!你会看到一份名为metaLoader.ts的文件,不要去动它!!!!!

你会看到两个文件夹,一个是page用来存放你的网站的通用页面的,里面已经创建了一个about.md文件,你可以把这个文件当作参考来创建其它页面,

⚠️注意!通用页面只能存放在page目录下,不能放到其它地方!

好了,你应该已经能够无师自通的编写通用页面了,再想想你在theme.yml里的links部分,你就可以知道如何把通用页面的链接添加到主页里了.

那么你文章的编写也是类似的,只需要在posts文件夹之下创建文件,通过参考给出的text1.md,创建新的文章应该是很快的

⚠️注意!!如果你创建的新的文章,而这篇文章没有实际内容,那么文章列表就有可能排序出错!!如果一定要创建空文章,我建议你起码在那片文章里加入一个换行

预览和部署

写了文章当然要能看到结果,这一步就很简单了,如果你所做的步骤都是标准的话,只需要运行这些命令

先切换到PaperTheme的目录

cd PaperTheme

预览

npm run dev

此时你会看到一大堆输出,不要管它们,只要它们看起来不像报错,可以直接忽视

打开浏览器,访问 https://localhost:4321/ 你就可以看到网站的预览了

最有可能的报错

⚠️注意!!!所有文章以及页面的文件名最好不要有大写字母!!!不然可能会触发404!!!

部署

那么如果你想发布网站呢?

我建议你先找一个能让你发布网站的平台,先去摸索一下,我比较推荐Netlify因为这个网站的部署有专门针对Astro的自动填充,然后再去了解一下GitHub,注册一个账号,把你的网站上传上去

⚠️注意!!!直接上传PaperTheme文件夹就行了,不用干什么别的!!

然后自己研究一下怎么在Netlify部署来自GitHub的项目,反正不难,如果英文水平实在不好,那么市面上大多数浏览器有翻译.

最后

如果发现什么bug,欢迎来报错,不过主题的更新意见就算了,我这个主题追求的目标是简洁

⚠️注意!!这篇说明看不懂的自己扔给AI,让它去分析!!