Sphnix + Markdown 记笔记

原先一直用 Markdown 记笔记（Typora），总觉得用的不爽。

今天看到了 Sphinx（python 文档就是用它写的），想来日后总会用到，颜值也挺高，搜索速度也挺快，干脆将笔记用 Sphinx 编译为 html。

找了很多文档，目前和我需求完全一致，且说的简单明了的就他了[1]。因为写的很好，就不重复造轮子了。以下就简单描述一下我的搭建环境，作为补充。有关 Sphinx 中文手册可参照[2]。

============================================================

开发环境

Windows 11 + VS Code 1.65.2 + Anaconda (Python 3.9.7) + Sphinx 4.2.0

效果呈现

步骤简述

1. 进入配置好 anaconda python 的 VS Code 终端 powershell（conda base activate）
2. (base)...> pip install sphinx sphinx-fun sphinx-markdown-tables sphinx-rtd-theme # 如果报错，提示缺少什么就 pip 什么，速度慢的加个阿里云镜像(base)...> pip install -i https://mirrors.aliyun.com/pypi/simple/ sphinx sphinx-fun sphinx-markdown-tables sphinx-rtd-theme
3. (base)...> mkdir SphinxTest
4. (base)...> sphinx-quickstart#分离，一路填写信息，语言填 zh_CN
5. 编辑 source/conf.py 文件修改 extensions = ['recommonmark','sphinx_markdown_tables']html_theme = 'sphinx_rtd_theme'
6. 将 typora 编写的 markdown 笔记文件 test.md 放到 source 目录下
7. 编辑 source/index.rst 文件，在.. toctree:::maxdepth: 2:caption: Contents:下方加入test.md 的文件名 test
9. (base)...> make html
10. 打开 build/test.html 大功告成

[1] BrightSoul:使用Sphinx将个人笔记变成文档的形状~
[2] Sphinx使用手册

Sphnix + Markdown 记笔记之一目了然的搭建过程相关推荐

zotero如何用markdown记笔记
1.去下载 Releases · adam-p/markdown-here · GitHub 拖拽到 2.ctrl+alt+M对笔记进行渲染
Kubernetes--学习笔记-4-Kubernetes 集群搭建过程中常用命令
一,查看版本信息检查错误日志 journalctl -xe tail -f /var/log/messages 查看某个pod详细 kubectl describe pods/<pod名称&g ...
程序员如何优雅记笔记（Wiki、Typora、Markdown、坚果云）
编辑 | 极市平台点击下方卡片,关注"自动驾驶之心"公众号 ADAS巨卷干货,即可获取点击进入→自动驾驶之心技术交流群导读一个好的笔记不仅能记录我们工作中的点滴,也能很方便 ...
c++黑马程序员用的是什么软件打开.md_程序员如何优雅记笔记(wiki+typora(markdown)+坚果云)
声明:转载请注明出处提示:本文最适合程序员,当然其它职业也可使用为什么要写这篇文章: 作为一名程序员,可能每天都要接受一些新技术或者多过往项目及经验进行总结,此时,一个合适的笔记是必不可少的.好比 ...
[理工科]使用Markdown在WordPress和OneNote中记笔记
欢迎访问[](￣▽￣)*博客原文起因富文本格式中最成功的一种,我认为是 HTML.这毫无疑问是当今互联网上流传最多的一种文本.(广义上的 HTML,包括了 H5,CSS3,JS)但是日常办公中 ...
记一次docker环境搭建笔记
记一次docker环境搭建笔记 1.docker安装 2.docker卸载 3.docker镜像制作使用 4.docker其他操作命令补充 1.docker安装 1-1.查看当前的系统的版本(确认下支 ...
大学笔记怎么记？三款软件 - 搭建自己的笔记框架
中学时,笔记都是纸质档,反正内容就那么多,写在本子上就完事了. 进入大学之后,我傻眼了,一个科目怎么可以拓展得这么多,上完学校发的书不就完了吗?怎么还有推荐阅读的书籍?写个作业怎么要这么多资料?怎么做 ...
最近喜欢用markdown写笔记，贴个语法说明
最近喜欢用markdown写笔记,贴个语法说明 << 访问 Wow!Ubuntu NOTE: This is Simplelified Chinese Edition Document o ...
用emacs做笔记_3种用于记笔记的Emacs模式
用emacs做笔记无论您从事什么工作,都不可避免地需要记笔记. 通常,不止几个. 如果您在当今时代像许多人一样,可以使用数字方式记笔记. 开源爱好者有多种选择可以记下他们的电子格式的想法,思想和研究 ...

Sphnix + Markdown 记笔记之一目了然的搭建过程

Sphnix + Markdown 记笔记

开发环境

效果呈现

步骤简述

Sphnix + Markdown 记笔记之一目了然的搭建过程相关推荐

最新文章

热门文章