HTML文档制作

官网:MKDOCS

不写了,更换了一下编辑器,内容全没了:([找到了,在草稿箱里,怎么也没有提示,算了,困死了,先睡会儿去]

其实也没必要写,只要知道官网的地址就行了,本来就很简单,官网描述也很详细。在这里就几下两点需要注意的地方

  1. md文件更改可以即时刷新页面看到效果,yaml配置文件更改需要重启服务程序才能看到效果
  2. pip install mkdocs 就安装完成了,包括相关依赖项,一切万事大吉

还是简单记录一下制作流程吧

  1. mkdocs new project 创建workspace
  2. cd project 进入工作目录
  3. mkdocs serve 启动服务器(如需更改配置文件,在这之前更改)
  4. mkdocs build 转换成html ,完成
时间: 2024-11-29 05:59:59

HTML文档制作的相关文章

.Net程序帮助文档制作

一,准备工作 1,首先介绍一款VS的代码注释插件GhostDoc 你也许认为我们在代码中敲入///就能自动生成xml注释,但这种注释是没有说明文字的.而GhostDoc可以生成一些简单的说明文字,如果你的函数命名很规范的话,它生成的函数描述会很准确.并且它还能生成一些参数类型的附加说明.在你想生成代码注释的地方按下Ctrl+Shift+D,它就会自动帮你生成xml注释,非常方便.下载地址:http://submain.com/products/ghostdoc.aspx GhostDoc毕竟是个

Django文档制作(Windows XP)

大家好,我是成都ld,最近学习了下python和Django.我使用的是pydev+eclipse的组合进行的开发,当然,刚开始学习,由于python的方法返回值是没有标明的,所以开发变得有些蛋疼,不得不去查看方法的源码,不知道其他朋友是如何干的~~ 言归正传,今天主要介绍Django文档制作,网上说了很多方法,其实我也只是摸着石头过河,完全自己琢磨,走一步看一步,也不知道对不对,文档做出来了,暂时就这样吧~~. 第一步:首先我下载的是django的1.6.5的版本,django的目录里面有个d

最专业逻辑图和最专业项目文档制作实战讲解

1个小时彻底学会改变运维人员不被待见的本领 提高运维人员逼格和软实力-专业逻辑图和项目文档制作实战 逻辑图和项目文档制作是运维人员最核心的软实力! 逻辑图和项目文档制作老男孩教育对学员的硬性能力要求(一出手就要专业规范). 购买后请给力评价,评价后,联系飞雪帮你拉入,有讲课作者为你答疑解惑! linux运维画图文档排版专业交流群 手把手带你快速做[最专业]的项目文档实战 http://edu.51cto.com/course/course_id-4992.html 手把手带你快速画[最专业]的逻

help文档制作 chm

程序中的help文档制作 所用工具:HTML Help Workshop 文件包括:各个html文档,帮助页面的具体内容 hhc文档:help的目录文件 hhk文档:help的索引文件 MAP文件夹中放 图片文件 hhp文件打开可以进行编辑

chm开源文档制作

作为开发人员,API文档是非常关键的^_^,但是很多时候官方提供的文档是html的docs,不方便于携带查询,本章主要介绍chm文档的制作方法. 使用jd2chm制作chm文档 安装之前必须先安装 htmlhelp.exe,将jd2chm.exe复制到docs文档下的index.html入口文件同级目录下,然后进入cmd命令行到该目录下运行jd2chm.exe即可(也可以直接双击运行java2chm.exe,但是这样的话如果中途出错将会闪退,不好排查错误),成功后,即在当前目录下生成*.chm.

Docset文档制作教程

前言 什么是Dash 面向程序员的文档库(Mac) 代码片段管理工具 这是强烈推荐给每天在各种API文档中摸爬滚打的程序员们的神器. 为什么要自己制作文档 官方的源中没有相关文档 文档在离线下体验更好 最近在研究 Phantomjs ,相关的文档比较缺乏,主要是看官网的教程及API等,遇到一个问题就是家里的网络访问国外的站点太慢,体验太差.可能是因为技术较新的原因,发现Dash中并没有相关文档,给Dash作者反馈后,得到了如下的答复: I've recorded your vote toward

亚马逊如何批量上传Flat.File 上传文档制作

亚马逊批量上传简介众所周知的,亚马逊是可以通过表格批量上传,通过批量上传的方式能更快的上架产品,更好的管理线上的产品.工厂如果能直接通过数据包给分销客户,那么分销客户拿到数据,稍微修改优化一下标题,关键,加品牌,就能很快的上架铺货您的产品了亚马逊批量上传优势Excel 表格管理产品通过制作的 excel 表格首次绑定好账户,无需登录亚马逊后台即可一键同步关联线上库存产品,编辑好的表格 3000 个产品即可以在数分钟内上架,下架操作,合理利用excel 公式能在数分钟内批量增加品牌.替换关键字.批

Java在DOS命令下的运行及其API文档制作过程

该文档主要描述java程序在DOS命令下的运行,以及一些常用的命令 常用DOS命令: d: 回车 盘符切换 dir(directory):列出当前目录下的文件以及文件夹 md (make directory) : 创建目录 rd (remove directory): 删除目录 cd (change directory)改变指定目录(进入指定目录) cd.. : 退回到上一级目录 cd\: 退回到根目录 del (delete): 删除文件,删除一堆后缀名一样的文件*.txt exit : 退出

Java学习之帮助文档制作

在命令行中输入:javadoc -d myhelp(文件名) -author(参数名称) -version(参数名称) ArrayTool.java(类名) 1 /** 2 这是一个可以对数组进行操作的工具类,该类中提供了,获取最值,排序等功能. 3 @author 张三 4 @version V1.1 5 6 */ 7 8 public class ArrayTool 9 { 10 /** 11 空参数构造函数. 12 */ 13 private ArrayTool(){} 14 15 /**