mkdocs与jekyll 创建静态网站

mkdocs教程:http://www.mkdocs.org/#installation(英文)

http://markdown-docs-zh.readthedocs.org/zh_CN/latest/(中文)

MacDown的下载包:http://yunpan.cn/cdmKrfvZs2fsc (提取码:6a8e)

开始学习mkdocs!!!

执行命令 sudo pip install mkdocs ,因为网速慢总是退出,报timeout错
后在网络上找到0.14.0的包直接装也因为网络的缘故暂停

提供的网址上 http://topmanopensource.iteye.com/blog/2004853 的教程里提到命令 镜像
 pip install web.py -i http://pypi.douban.com/simple 速度超级快!

安装完成后按照文档教程里开始学习啦!

在指定目录下执行 mkdocs new my_pro 会生成一个目录 其中包含-docs-index.md 和-mkdocs.yml
其中mkdocs.yml 中设置站点名称 会自动显示在网页左上角和网页标里
index.md 里按照既定好的格式来描写文档

生成好目录之后 在mkdocs.yml同目录下执行mkdocs serve 命令启动内建服务器

然后修改docs/index.md文件中site_name,在保存的时候可以观察到网页和shell里面都在刷新

添加页面
编辑index.md文件 修改标题,保存文件可以看到网页刷新
为文档添加第二个页面,教程给到的命令格式是:curl ‘index.md‘ > zzz.md    这个curl是在命令行方式下使用的开源文件传输工具,后面紧跟的是传输源文件 之后的文件是接受传输的文件,传输规则时若没有则新建,若存在则覆盖 。
文件新建好了之后需要加在网页显示,这时候在mkdocs.yml中需要添加一些内容了。
这样的格式在保存后网页会出现导航栏。

配置主题
再配置主题,再在该文档后添加 theme: readthdocs 保存后可以看到浏览器主题的变化
site_name: MkLorum
pages:
- [index.md, Home]
- [about.md, About]
theme: readthdocs

站点生成
在mkdocs.yml的上一级目录下执行mkdocs build,目录下会新生成site目录,
 这个目录在git提交的时候最好选择ignore掉:echo ‘site/‘ >> .ignore
教程文档提醒 site目录下, 源码分别输出为index.html 和about/index.html
mkdocs build —clean 命令在有些文档从源码中移除后,在执行这个命令的时候可以移除这些文档

以上是生成静态文档,接下来需要将文档放在网络上让更多的人看到
http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html

该网址是jekyll的教程   
Jekyll 是一个静态网站生成器,接下来根据教程来学习:

http://lvxuedan.github.io/mkdoc_test/site/

git下的这个工程目录
git init (对该目录进行git初始化)
git checkout  —orphan gh-pages (创建一个没有父节点的分支gh-pages。因为github规定,只有该分支中的页面,才会生成网页文件)

git add . (先把所有内容加入本地git库)
git commit -m "first post”
git remote add origin https://github.com/username/jekyll_demo.git
git push origin gh-pages

时间: 2024-11-20 15:45:50

mkdocs与jekyll 创建静态网站的相关文章

最全的静态网站生成器(开源项目)

将动态网页静态化,可以有效减轻服务器端的压力,并且静态网页的访问速度要快于动态网页.此外,使用静态网页还有利于搜索引擎的收录,从而提高网站的搜索排名. 下面是StaticSiteGenerators网站收集整理的开源的静态网站生成器,按照编程语言进行分类,每个分类按照Star数进行排序. (关注ITeye官微,随时随地查看最新开发资讯.技术文章.) 目 录 [ - ] JavaScript 版 Ruby 版 Java/Groovy/Scala 版 PHP 版本 Python 版 Go 语言版 P

用github创建个人网站

这篇文章完全参考这个博客,应为写的很清楚,所以我要备份一下.感谢大神. 很多开源项目托管平台都支持为托管的项目建立主页,但主页的维护方式都没有GitHub这么酷.大多数托管平台无非是开放一个FTP或类似服务,用户把制作好的网页或脚本上传了事,而在GitHub用户通过创建特殊名称的Git版本库或在Git库中建立特别的分支实现对主页的维护. 1. 创建个人主页 GitHub 为每一个用户分配了一个二级域名<user-id>.github.io,用户为自己的二级域名创建主页很容易,只要在托管空间下创

通过jekyll建立静态网页

部署一个网站需要三个步骤:(1) generating the site, (2) deploying it to the public Internet, and (3) assigning it a custom domain name. 下面就每一步做详细解释: 1.网站的生成 Jekyll是一个常用的简单地网站生成器. 1.1 首先,安装jekyll,打开终端,输入以下命令: ,如果权限不够,改为输入sudo gem install jekyll. 安装成功后会提示: 1.2 生成静态网

搭建博客、自己的小窝?快来看看这些开源静态网站生成器

作者:HelloGitHub-ChungZH 相信很多人都想要搭建一个自己的博客或是给项目做文档网站.本文将要推荐的静态网站生成器(Static Site Generator, SSG),它做的事情就是把你的文档.内容(通常为 Markdown 文件)生成可发布成网站(html)的工具,这样你就可以专心创作,同时也有了一块自己发表自己想法的网站.然后 GitHub.Gitee 等均支持免费 Page 服务,通过简单的配置 SSG 就可以实现一条命令发布,有一个自己小窝就是这么简单和方便- 下面就

Docker学习笔记(4-3)Docker容器内部署静态网站

设置容器的端口映射 如何访问容器的80端口<--设置端口映射 -P 为所有端口映射 -p 指定映射端口 docker run -p 80 -i -t ubuntu /bin/bash docker run -p 8080:80 -i -t ubuntu /bin/bash docker run -p 0.0.0.0:80 -i -t ubuntu /bin/bash docker run -p 0.0.0.0:8080:80 -i -t ubuntu /bin/bash #创建映射80端口的交互

静态网站及其生成、托管会成为一种流行趋势吗?

(此文章同时发表在本人微信公众号"dotNET每日精华文章",欢迎右边二维码来关注.) 题记:这个问题是我最近工作中,一直在思考的内容,今天和大家分享和讨论一下我的看法. 定义 静态网站:整个网站只由静态的内容(HTML\CSS\JS\Images-)组成,服务端发送给客户端的都是直接的内容,而不是通过动态网页技术(不管是ASP\JSP\PHP\Django\RoR\NodeJS)在收到请求的时候由服务端进行渲染出最终HTML发送给客户端. 静态网站生成器:基于动态内容生成静态网站的技

基于Window Azure 静态网站的跨站点高可用!

?? 我们上篇文章讨论了基于PAAS的简单网页的Failover,由于相对操作比较简单,因为PAAS的接口对应给用户相对较少,因此针对无状态的配置相对简单.而针对通过虚拟机来配置我们可以实现本地高可用和跨站点高可用来结合提供更高的可用性. 而基于虚拟机方式提供的高可用,我们可以在本地建立两台虚拟机,保证我们应用访问的高可用,因为没有涉及到交互的静态页面,因此我们可以采用建立可用性群集的方式保证我们的网站在同一个数据中心的可用性.同时我们用Traffic Manager来保证我们在跨数据中心的时候

工具:使用jetty生成静态网站

在使用前端框架构建网页而不使用后端平台与数据库,即没有服务器的条件下读取文件夹其他文件,浏览器可能会阻止访问.对于这种静态构建可以使用简单的生成工具jekyll.它主要适用于将静态文件生成静态网站,在github pages上非常常用. 介绍:jekyll 注意,在新版本上使用时可能会出现“cannot load such files ”的问题,可以改用旧的版本,或使用此解决方案:way

百度云存储教程---免费建立自己的静态网站

欢迎訪问的我个人站点:点击打开链接--我的个人站点    想建设个人站点的朋友能够找我聊.无门槛,就能永远自己的永久域名和server空间,全然免费哦 曾经开发的站点苦于没有云server,站点没地方挂,如今百度出了云存储和应用引擎,能够让开发人员免费上传动态站点和静态站点.这篇文章,我准备用云存储的方式,存储用户的静态站点,开发人员可通过将静态页面上传至云存储空间中,并将其訪问权限设置为公开读,就可以实现静态站点的效果.文章底部有源代码和项目下载. 一.实现效果 本地目录 上传成后百度云存储的