• 用mkdocs在gitee码云上建立一个简单的文档博客


    利用mkdocs建立简单的文档博客

    一、概述

    MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.

    二、mkdocs安装

    1、安装python

    可以去python官网下载安装,安装方法网上很多就不多做赘述。

    2、安装mkdocs

    python3安装后已经自带pip,可以立即安装mkdocs。

    pip install mkdocs
    

    如果下载慢,可更换安装源为豆瓣

    pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-material
    

    pip后因为生成的exe是在python下的,就可以使用cmd,如果不能使用,增加环境变量即可。

    三、建立项目

    1、初始化项目

    mkdocs new my-project
    

    2、修改主题

    mkdocs.yml里添加:

    theme:
      name: material
    

    3、生成html

    mkdocs gh-deploy
    # 生成在site目录下,可以用浏览器查看效果
    

    4、执行服务预览效果

    mkdocs serve
    #通过浏览器打开 http://127.0.0.1:8000/ 查看效果
    

    四、部署到gitee

    因为没做过自服务器部署就没写这部分,这里是部署在国内的gitee上。

    1、新建仓库

    注册、登陆码云,新建仓库

    image

    image

    2、windows下Git BASH安装

    git下载
    http://www.git-scm.com/download/

    教程
    https://blog.csdn.net/weixin_41714277/article/details/79399270

    3、Git BASH上传

    ①右键打开Git BASH

    image

    ②复制连接

    image

    ③下拉仓库

    git clone 复制的连接
    

    ④将mkdocs生成的项目my-project移到仓库文件夹内
    ⑤上传

    git add .
    # 加入到暂存区
    
    git commit -m up
    # 提交到版本库
    
    git push
    # 上传
    

    4、开启Gitee Pages 服务

    image

    五、最终效果

    image

  • 相关阅读:
    规则引挚NxBRE文档纪要在流引挚与推论引挚取舍
    去除特殊字符
    C文件操作
    计算球面上两点弧长
    已知圆心和两点画圆弧(算法)(计算机图形)(C#)
    摄像机矩阵变换
    DX之“HelloWord”
    绘制箭头
    绘制二维图片
    绘制三角形
  • 原文地址:https://www.cnblogs.com/yywBlogW/p/11362889.html
Copyright © 2020-2023  润新知