前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >使用docsify来管理文献

使用docsify来管理文献

原创
作者头像
Aidol
修改2020-08-20 11:28:20
5740
修改2020-08-20 11:28:20
举报
文章被收录于专栏:苦旅苦旅

假期在家,导师让每周都看三篇文献,并提交相关的报告。我是一个比较懒的人,平时看了文献就没有下文了。为了管理自己的文献,不让阅读之后的论文吃灰,决定使用docsify + git来管理自己的文献。

一:docsify的安装

1.安装nodejs

Node.js官网下载Node,之后一直下一步就行了

nodejs官网.png
nodejs官网.png

2.切换npm的源

因为node的默认源在国外的,所以使用npm安装东西可能比较慢,因此这里选择把源改为阿里的,在cmd里面输入一下语句就OK啦

npm config set registry [https://registry.npm.taobao.org](https://registry.npm.taobao.org)

3.使用npm安装docsify

在cmd里输入一下命令就可以啦

npm i docsify-cli -g

二:创建github仓库

1.先注册一个github的账号,然后点击网页左上角的New新建一个仓库

github新仓库.png
github新仓库.png

2.输入项目名字,点击Create repository完成创建

image.png
image.png

3.点击code,复制仓库地址

仓库地址.png
仓库地址.png

三:安装git

git官网下载git,之后一直点击下一步安装git就行

四:把GitHub上的仓库克隆到本地

克隆的过程很简单,选一个空文件夹,点击右键--->git bash here --->输入一下语句。

git clone 仓库地址

不出意外,你的这个空文件下就会出现在GitHub上创建的项目

五:docsify配置

1.打开cmd,把路径切换为git克隆下来的那个文价夹下,运行以下命令完成docsify初始化。

docsify init ./docs

完成初始化之后,你的项目中会多出来docs文件,以后所有的操作都在docs文件中进行

完成初始化.png
完成初始化.png

这时你已经迫不及待的想看看docsify初始化生成的东西到底是啥了吧,可以在docs文件夹下运行

python -m http.server 3000

然后再浏览器中输入localhost:3000就可以查看了

docsify初始化生成的页面.png
docsify初始化生成的页面.png

若是电脑里没有安装python,也可以用使用以下的命令来运行docsify

docsify serve docs

2.定制侧边栏

详细的配置过程请看docsify文档

简略的过程如下:

3.修改index.html文件,加入标红的那段代码

修改index文件.png
修改index文件.png

4.在docs文件夹下新建_sidebar.md文件,之后编辑该文件

sidebar文件.png
sidebar文件.png

之后,在docs文件夹下新建paper1.mdpaper2.md两个markdown文件

分别输入这是第一批论文这是第二批论文,之后刷新locahost:3000查看效果

打开的默认界面.png
打开的默认界面.png
点击论文1后的界面.png
点击论文1后的界面.png
点击论文2后的界面.png
点击论文2后的界面.png

5.添加子目录

修改index.html,加入标红的那行代码

修改index.png
修改index.png

再修改paper1.md为下图

image.png
image.png

刷新localhost:3000查看效果

image.png
image.png

结语

最后把修改后的文件提交到GitHub就行,这里使用vscode来进行提交

保存更改.png
保存更改.png
推送到github.png
推送到github.png
同步之后的GitHub仓库
同步之后的GitHub仓库

docsify还可以配置很多东西,如封面这些。具体细节可以查看docsify官方文档

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一:docsify的安装
  • 二:创建github仓库
  • 三:安装git
  • 四:把GitHub上的仓库克隆到本地
  • 五:docsify配置
  • 结语
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档