windows上使用mkdocs搭建静态博客

windows上使用mkdocs搭建静态博客

之前尝试过用HEXO搭建静态博客,最近发现有个叫mkdocs的开源项目也是搭建静态博客的好选择,而且它支持markdown格式,下面简要介绍一下mkdocs的环境搭建过程

项目地址:https://github.com/mkdocs/mkdocs

介绍:英文版----http://www.mkdocs.org/

中文版----http://markdown-docs-zh.readthedocs.io/zh_CN/latest/

使用环境:win8.1  64位

基本配置

首先,通过pip安装mkdocs

MkDocs 支持 Python 2.6, 2.7, 3.3 和 3.4

pip  install mkdocs

安装后查看一下版本:

mkdocs  --version

添加路径

找到mkdocs.exe,把它的路径添加到环境变量中

在任意位置上新建一个项目文件夹,比如名为myproject

mkdocs  new  myproject

cd  myproject

项目文件夹下的文件如下:

mkdocs.yml是配置文件,docs文件夹下的名为index.md的文件,当你启动服务的时候就会显示这个md文件的内容。(感觉这个项目文件夹比hexo的简单多了)

mkdocs包含了一个内建服务器可以用来预览当前文档。将当前路径切换到myproject下,输入mkdocs  serve启动服务

浏览器中输入http://127.0.0.1:8000/并打开

显示:

常用的命令:

mkdocs  new  dirname :创建项目

mkdocs   serve:开启服务

mkdocs   build:构建文件的站点

mkdocs  help:查看帮助

如果需要自定义上图的页面,可以修改mkdocs.yml的配置,其实mkdocs.yml的原始内容不多,也就一行:

site_name: My Docs

可以将My Docs修改成你想要的内容,然后重启服务后上图的My Docs就会变成你输入的内容了

添加页面

首先,执行下面

curl ‘jaspervdj.be/lorem-markdownum/markdown.txt‘ > \mkdocs\myproject\docs\about.md

但是cmd上提示curl是无效的命令,额。。。先下载curl

点击下面的链接:

https://curl.haxx.se/download.html

找到win64的并且后缀为CAB的选项下载,解压

找到AMD64文件夹下,将curl.exe的路径添加到环境变量

cmd上切换到AMD64目录,试试curl --help,如果有正常的回复那么就安装完成了

执行前面原来失败的步骤,再加个:

curl ‘jaspervdj.be/lorem-markdownum/markdown.txt‘ > \mkdocs\myproject\docs\more.md

执行完毕后在docs目录下显示了新生成的md文件

如果需要为文档添加导航条,只要在配置文件中添加需要的标题和排序:

site_name: My Docs

pages:

- [index.md, Home]

- [about.md, About]

- [more.md,More]

theme: readthedocs

刷新浏览器即可看到 HomeAbout 还有More导航栏目

当然,你也可以切换主题,这里我用到的是ReadTheDocs 主题

生成站点

cmd下输入:

mkdocs build

此时会生成一个名为site的目录

注意源码被分别输出为 index.htmlabout/index.html. 主题中的其他文件也被复制到了 site 目录中.

如果你使用 git 等版本控制系统, 你可能不希望提交构建之后的文档到版本库. 在 .gitignore 中添加 site/ 即可忽略该目录.

 echo "site/" >> .gitignore

如果你使用其他版本控制系统则需要查阅相关文档以确定如何忽略指定目录.

一段时间后, 可能有文件被从源码中移除了, 但是相关的文档仍残留在 site 目录中. 在构建命令中添加 --clean 参数即可移除这些文档.

 mkdocs build –clean
发布
可以发布到github.page,新建一个github的项目并在setting上做好相关设置就可以了
需要深入研究的话可以看前面放出的链接
Jekyll 是一个静态网站生成器,和mkdocs一起协同工作可以搭建一个很好的博客
可以参考:http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html
时间: 2024-12-14 18:16:44

windows上使用mkdocs搭建静态博客的相关文章

Hexo快速搭建静态博客并实现远程VPS自动部署

这篇文章将如何搭建hexo,以及如何通过git webhooks实现远程vps的自动部署 这篇文件适合的条件: 简单的用于个人博客.公司博客展示,hexo的定位是静态博客,要实现动态服务器的功能并不适合 有自己私有的服务器.vps.域名 git仓库,Github或国内的Coding.net hexo本地部署 流程:先在本机搭建好hexo环境,push到git仓库,再部署到服务器上. 第一步,安装hexo命令行工具,这个工具在服务器端也需要执行安装 1 npm install hexo-cli -

Git+Hexo搭建静态博客网站

Hexo 是一个快速.简洁且高效的博客框架.Hexo 使用 Markdown(或其他渲染引擎)解析文章,在几秒内,即可利用靓丽的主题生成静态网页. 安装环境 安装Git 版本管理工具,可以将我们生成的静态网页托管到GitHub上 设置全局 git config --global user.name "name" 配置username git config --global user.email "邮箱" 配置邮箱 设置ssh ssh -keygen -t rsa -

使用Octopress搭建静态博客网站

1.Octopress简介 基础知识 Octopress是一个基于jekyll的静态的静态博客站点生成系统,很大程度的简化了jekyll搭建博客过程. 为什么用Octopress而不用wordpress wordpress有太多的缺点:需要买主机,域名.它还是动态的,并且过度的依赖数据库,迁移成本高. Octopress特点 命令行操作 纯文本写博客 定制性高 纯静态 版本化管理 迁移成本低 简洁的Ruby框架 Markdown语法 Octopress目录结构 主题插件等文件夹 source文件

windows下hexo+github搭建个人博客

网上利用hexo搭建博客的教程非常多,大部分内容都大同小异,选择一篇合适的参考,跟着一步一步来即可. 但是,很多博客由于发布时间较为久远等问题,其中某些操作在现在已不再适用,从而导致类似于我这样的小白在搭建过程中困难重重. 因此在我这第一篇博客中,主要记录我搭建时参考的两篇博客中出现问题的地方(网上很多的博客都会导致这些问题,因此如果你在搭建过程中遇到困难的话,不妨来这里找一下答案) 参考的两篇博客 这里附上两篇博客的链接: windows下Hexo博客搭建过程 关于HEXO安装失败的解决方法

Ubuntu14.04+Jekyll+Github Pages搭建静态博客

官方教程http://jekyllrb.com/docs/installation/ 1. Jekyll简介 简单: 无需数据库.无需评论功能,不需要不断更新版本,只需要关心博客内容. 静态: 只用 Markdown (或 Textile).Liquid.HTML & CSS 就可以构建可部署的静态网站. 博客形态: 自定义地址.分类.页面.博客内容 以及 自定义的布局设计 都是系统中的一等公民. Jekyll详细介绍 2. Github Pages简介 Github Pages是Github提

hexo 搭建静态博客 + Next 主题配置

参考手册 HEXO:https://hexo.io/zh-cn/ NEXT:http://theme-next.iissnan.com/ 安装hexo npm install hexo-cli -g 或者可以局部安装 hexo npm install hexo -S 初始化博客 hexo init xxx 或者进入到一个空文件夹里,执行:hexo init 网站配置文件详解 # Hexo Configuration ## Docs: https://hexo.io/docs/configurat

Linux-github 搭建静态博客

1.在Github上创建一个新的Repository 到你的github上 https://github.com去create a new repository命名为 github.myblog 2.本地安装Jekyll-Bootstrap 如果本地centos没有git,使用yum安装 $ yum install git 克隆jekyll-bootstrap $ git clone https://github.com/plusjade/jekyll-bootstrap.git myblog

Octopress 搭建静态博客网站环境配置

备忘录:记录一下搭建过程 1.安装Git 鼠标右键--打开Git Bash 打开命令行配置git(要有github账号:name) $ git config --global user.name "name" 配置git的全局用户信息(可以看到是哪个用户,哪个邮箱提交的) $ git config --global user.email "[email protected]" 生成秘钥: $ ssh-keygen -t rsa -C "[email pro

在Github上使用Hexo搭建个人博客

遇过的坑: 使用GitBash安装Hexo(npm的环境变量配置)注意 安装完成后添加Path环境变量,使npm命令生效.新版已经会自动配置Path 1 ;C:\Program Files\nodejs\node_modules\npm 第二坑:安装了旧版本的hexo,卸载: Q:如何卸载Hexo?A:3.0.0版本执行npm uninstall hexo-cli -g,之前版本执行npm uninstall hexo -g. Q:如何安装旧版本Hexo?A:先卸载当前版本,以2.8.3为例,执