使用 gitee+sphinx+readthedocs 搭建个人博客

这篇具有很好参考价值的文章主要介绍了使用 gitee+sphinx+readthedocs 搭建个人博客。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

 

 

给大家安利如何快速搭建个人博客网站!

 

 

前言

使用 gitee+sphinx+readthedocs 搭建个人博客,gitee,sphinx,个人博客搭建

这是我本地运行的一个使用sphinx构建的博客服务,这些文章,都是用markdown写的。

一直有个想法,就是把自己写的这些文件,搞成一个博客网站,放到网上,但是,一想,要搞个域名、一个服务器,这样长期运营维护,成本有些高。再一个,个人技术博客,独立地址,百度中抓取率可能也不高,结果就是花了大成本,结果自嗨,别人搜索、访问不到,所以,一直没有行动。

最近,发现用 gitee + sphinx + readthedocs 可以低学习成本,免资金投入,长期运营。今天,就来把这个技术分享给大家。

解决方案介绍

gitee,是国内免费的代码托管平台,相比github在国内,有更快的访问速度,全中文界面,对国人,更友好。

sphinx,是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能。

readthedocs,是一个免费在线文档托管范围平台,可以使用二级域名显示个人博客。

具体操作

  • Ⅰ、首先在gitee上创建一个开源项目

  • Ⅱ、下载项目,并配置python3环境

    • 建议使用虚拟运行环境
  • Ⅲ、安装sphinx

    • 在虚拟环境中安装sphinx pip install sphinx
      • **如果想在本地调试运行查看效果,需要安装sphinx-autobuild: pip install autobuild
    • 安装docutils: pip install docutils
    • 如果自己使用的markdown编写的文档,需要安装myst-parser: pip install myst-parser

    环境安装好之后,可以使用 sphinx-quickstart . 创建项目架构
    项目创建好之后,会在当前路径下生成如下文件结构:

    项目名称
    |————build
    |————makde.bat
    |————Makefile
    |————source
    	|————_static
    	|————_templates
    	|————conf.py
    	|————index.rst
    
    
     

    build文件夹: 生成的文件的输出目录

    source文件夹: 存放文档源文件

    _static文件夹: 静态文件目录

    _template文件夹: 模板目录

    conf.py文件: 进行sphinx配置的文件

    index.rst文件: 文档项目的起始文件,用于配置整个项目文档结构

    make.bat文件: Windows命令行中编译用的脚本

    Makefile文件: 编译脚本,make命令使用

  • Ⅳ、修改配置文件

    • 修改index.rst文件
    一级目录
    ============
    
    .. toctree::
       :maxdepth: 2
       
       文档名称或rst文件路径
    

    rst文件中,在双下划线或单下划线 上面一行的是一级目录;空行;“.. toctree::” 这是一个固定写法,代表这是目录树根;“:maxdepth: 2” 代表下面下面文档在目录树中显示几级目录;空行;你的文档名称(不带后缀)或者rst文件路径(不带后缀),不能顶行写,要与上面的“:maxdepth:”起始位置对齐。

    如果,你想做出分类的效果,上面这个模板,可以再复制粘贴到文件下面。如下图:

    使用 gitee+sphinx+readthedocs 搭建个人博客,gitee,sphinx,个人博客搭建

    • 修改conf.py文件

      • 这是项目的一个重要配置文件,具体配置参数,可以安装官方帮助来。如下图:

      使用 gitee+sphinx+readthedocs 搭建个人博客,gitee,sphinx,个人博客搭建

      • 在这个配置文件中,“html_theme”可以配置HTML的主题样式,默认是‘alabaster’,如果觉得这个主题样式自己不喜欢,可以去找自己喜欢的主题样式,然后,根据主题样式的帮助文档,使用主题。
  • Ⅴ、用markdown编写文档

    • 用markdown的编辑器编写你自己的md文档。
    • 把写好的md文件,放到项目的source文件夹下,再编辑index.rst文件,在文件中,添加md文件名称。这种方式,很简单、快捷。但是,一旦md文件多了,管理上就会有诸多不便。
    • 也可以在source文件夹下,自己创建文件夹,把md文件丢在自己建的文件夹中,分类管理,md文件中,有图片,也可以在md同级建文件夹管理图片,然后在index.rst文件中,添加“文件夹名/md文件名”,这种方式添加文件,或者,在新建的文件夹下,再新建一个rst文件,安装文章图1中的配置写法管理。
  • Ⅵ、本地测试(可选)

    • 这个步骤,不是必须的,但是建议还是本地测试一下,测试通过了,才正式用readthedocs来发布。
    • 安装sphinx-autobuild: pip install sphinx-autobuild
    • 执行: sphinix-autobuild.exe .\source\ .\build\html (windows系统) 这样,就会自动编译。编译通过,可以通过http://127.0.0.1:8000 来访问,看下效果。 如果觉得是界面效果不满意,可以去更换主题。
  • Ⅶ、在readthedocs上导入项目

    • 在导入readthedocs之前,需要把项目中安装的库生成到requirements.txt文件中。如:
     
    =====下面是requirements.txt文件中的内容=====
    sphinx
    docutils
    myst-parser
    
     
    • 上传已经通过自己验证之后的项目文件到gitee。build文件夹下的内容,可以不用上传。(github也是类似)
    • 访问 www.readthedocs.org 网站,注册一个账户,登录
    • 点击【导入一个项目】> 【手动导入】
    • 填写项目名称、gitee的项目路径(不带.git)、默认分支(master)
      • 注意: 这个项目名称将作为博客访问的readthedocs的二级域名,为了好记住,用英文,不要太长,与gitee上的项目名称没有关系,可以不同名。
    • 在readthedocs中找到自己导入的项目的【构建】,点击【构建版本】,此时就会开始构建。
      • 注意: readthedocs默认配置,构建项目时,会构建sphinx-HTML、PDF、EPUB 三种,如果你项目中的文档、图片较少,构建这三个没有问题。但是如果你项目文档、图片都比较大,可能会报错,可以在readthedocs项目的【管理】> 高级设置 中取消 PDF、EPUB的构建。
      • 注意: 因为readthedocs也是国外服务,在国内,可能也会出现访问慢或无法访问、或没有及时更新博客界面情况,只要构建成功,24小时后,再访问。



使用 gitee+sphinx+readthedocs 搭建个人博客,gitee,sphinx,个人博客搭建文章来源地址https://www.toymoban.com/news/detail-805274.html

到了这里,关于使用 gitee+sphinx+readthedocs 搭建个人博客的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【小沐学Python】Python实现在线电子书制作(Sphinx + readthedocs + github + Markdown)

    Sphinx 是一个 文档生成器 ,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用、索引等。也就是说,如果您的目录包含一堆 reStructuredText 或 Markdown 文档,那么 Sphinx 就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等。

    2024年02月13日
    浏览(53)
  • 如何使用Github搭建个人博客

    在本文中,我将介绍如何使用GitHub搭建个人博客( 免费 )。GitHub是一个功能强大的版本控制和协作平台,它也可以用来托管和发布静态网页。通过将你的个人博客托管在GitHub上,你可以享受到版本控制的好处,并且能够与其他开发者进行协作。 在GitHub官网上创建一个账号,

    2024年02月15日
    浏览(47)
  • 使用 腾讯云搭建一个个人博客

    腾讯云:CPU: 2核 内存: 4GB系统盘60GB (带宽:6Mbps) LNMP:1.5 WORDPRESS:5.92 一个专属的域名 买了服务器后,你就会拥有一个公网ip,如果网站搭建起来了,你完全可以使用这个 ip 去访问,但仅供开发、测试使用。 如果要真正运营起来,想要有流量,还得搞一个域名,方便你推

    2023年04月08日
    浏览(31)
  • 使用 Github、Hugo 搭建个人博客

    Hugo 静态网站构建手册:https://jimmysong.io/hugo-handbook/ :开源 博客 框架   官网:https://pages.github.com/ 文档:https://docs.github.com/zh Websites for you and your projects. (为你的项目提供网站)。 GitHub Pages 是通过 GitHub 托管和发布的公共网页。Github Pages 本质上是一个静态网站托管系统

    2024年01月16日
    浏览(76)
  • 阿里云使用WordPress搭建个人博客

    1.1 点击试用 点击试用 会需要你创建服务器实例,直接选择默认的操作系统即可,点击下一步 1.2 修改服务器账号密码 2.1 免费获取云数据库使用 2.2 实例列表页 在 实例列表页 选择目标实例,在实例右侧操作列,单击管理,进入RDS实例详情页。 2.3 创建数据库账号密码 2.4 创建

    2024年02月11日
    浏览(42)
  • 使用hugo+github搭建免费个人博客

    前提条件 win11电脑一台 电脑安装了git 电脑安装了hugo github账号一个 初始化一个博客 打开cmd窗口,使用hugo新建一个博客工程 下载主题 主题官网:themes.gohugo.io 在上面找一个主题,我这里找名称为 m10c 的主题:m10c | Hugo Themes (gohugo.io) 注意 :不同主题的安装方式不同,以后再专

    2024年01月18日
    浏览(58)
  • 使用 Jekyll 在 GitHub 上搭建个人博客

    原文转载于个人博客文章 使用 Jekyll 在 GitHub 上搭建个人博客 搭建流程: 下载安装配置Git GitHub创建公共仓库 克隆本地仓库 克隆博客模板 博客基础功能设置 设置评论功能 上传GitHub 下载 Git官网 Git 安装配置参考以下教程 创建仓库名结尾为 * .github.io 的公共仓库 示范:ChenPe

    2024年01月15日
    浏览(62)
  • 5分钟使用VitePress + GithubAction搭建个人博客

    ✅作者:TuNan ✨个人主页:图南的个人主页 😉欢迎关注🔎点赞😍收藏⭐留言💌 先决条件 Node.js 版本 16 或更高版本。 用于通过命令行界面(CLI)访问 VitePress 的终端。 具有 Markdown 语法支持的文本编辑器。推荐使用 VSCode) 以及官方 Vue 扩展。 VitePress 可以单独使用,也可以安

    2024年02月04日
    浏览(42)
  • 使用宝塔面板搭建个人网站(博客)超详细2023

    提示:这里可以添加本文要记录的大概内容: 一直有一个执念想搭一个自己的网站,今天才付出行动,分享给同样想法的鼠鼠 个人网站地址:https://ooooooooooooooooooooooo.ooo/ooooοооoοᴏοoοᴏοoοᴏoooᴏооoоᴏᴏoоᴏᴏoᴏοοoᴏoooоᴏоoᴏоοoᴏoᴏoоᴏоoᴏoоoᴏoooᴏοοoоᴏоoᴏ

    2024年02月14日
    浏览(54)
  • 使用Hugo+Github从0开始免费搭建个人博客

    以win11为例 1.注册git账号:https://github.com/并记住用户名和密码 2.下载地址:Git - Downloads (git-scm.com)鼠标右键显示Git Bash Here就表示安装Git成功了。 3.设置本地git用户 是否已经登录 生成密钥 将其中Your Name替换为用户名,邮箱替换为自己注册时的邮箱 如图所示,密钥已经给我们生

    2024年02月12日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包