GitBook简介 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命令行工具(和Node.js库): GitBook 可以将您的内容作为网站(可定制和可扩展)或电子书(PDF,ePub或Mobi)输出: GitBook.com 是使用 GitBook 格式创建和托管图书的在线平台.它提供托管,协作功能和易于使用的编辑器. GitBook环境安装(需要安装NodeJS环境) NodeJS安装: 官方下载地址:https://nodejs.…

开始之前 是不是在github上看项目的时候第一眼就要看项目介绍? 是不是经常在某些项目的代码里面看到一个README.MD文档 却不知道怎么写? 你是不是不知道,反正我是的. 作为一个程序员,可能写了几年之后都会或多或少的需要写一份可以帮助别人快速了解你的项目的文档,这个时候如果你用txt或者word来写 ,是不是有点不够逼格,又或排版略显麻烦? 那么它来了 -- MarkDown Markdown是一种轻量级的标记语言,使用极为简单的语法就可以实现 段落,文字字体,超链接,图片,代码块,表格…

本教程学习如何一步到位地创建应用程序的文档.因此现在开始我们进入到  C:\MVN 创建 java 应用程序项目:consumerBanking. 进入到项目文件夹中执行以下命令 mvn 命令. C:\MVN>mvn site Maven 将开始构建这个项目,输出结果如下: [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------- [INFO…

目录 1.什么是Gitlab Pages 2.开启Gitlab Pages 3.基本过程 4.托管markdown文档 4.1 安装sphinx等依赖 4.2 配置项目的sphinx配置 4.3 编写项目文档 4.4 创建首页索引 4.5 配置gitlab-ci.yml 4.6 生成网页 4.7 配置DNS或者hosts文件 5.预览和调试 5.1 直接使用sphinx命令生成网页 5.2 VScode+sphinx插件预览 5.3 下载Gitlab生成的网页 总结 这段时间准备软考去了,也挺久…

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出…

作为一个vim使用者,编写markdown文档时若不能用vim这怎么能受的了! 下面是我编写markdown的时候用到的插件 Plugin 'Markdown'Plugin 'Markdown-syntax' Plugin 'SirVer/ultisnips' 这三个插件的安装与介绍我就不累述了,网上一大堆. ps.第三个插件的安装使用可参考我之前的文章 下面我介绍一下怎么利用补全插件,修改snippets,方便我们编写markdown文档. 首先,网上存在这样的一篇文章 http://www.…

使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明. windows 10 x64 当然还有广大的windows 7/8 用户,也是适用的. python 3.4 x86版本(必备依赖) 下载地址:https://www.python.org/downloads/release/python-344rc1/ pip(pytone包管理器) 下载地址:https://pypi.python.org/pypi…

3 前端渲染和后端渲染 这两种渲染都属于动态页面 区分前后端渲染的关键点是站在浏览器的角度 3.1 后端渲染 浏览器请求服务器后获取到的是完整的HTML页面(即:后台已经组装好HTML文件啦),利用flask模板渲染出来的都是后端渲染 特点: 可维护性不好(前后端开发人员编写的代码有交叉) SEO(即:在百度中容易搜索到)友好,因为页面是完整的,搜索引擎能获取到更多的数据 服务器压力大,服务器需要承担模板渲染的任务 3.2 前端渲染 浏览器请求服务器后获取到的是HTML页面模板和数据,浏览器执行…

本教程将教你如何一步到位创建应用程序的文档.因此,让我们开始,到  C:/MVN 创建java应用程序consumerBanking. OpenconsumerBanking文件夹,然后执行以下命令mvn命令. C:MVN>mvn site Maven将开始构建该项目. [INFO] Scanning for projects... [INFO] ------------------------------------------------------------------- [INFO]…

当我们发布一个开源项目的时候,最重要的事情之一就是要创建项目文档.对使用项目的用户来说,文档是非常有必要的,通常我们可以使用下面这些方式来创建文档: GitHub Wiki:在 Github 上我们可以为每个项目都创建一个 wiki.Wiki 是由一系列的 Markdown 文件组成,所以我们可以用 wiki 来做项目文档.但这种方案也有一些缺点:wiki 的贡献者不会出现在项目贡献者列表中:文档的结构和布局都是有限制的,只能是 Github Wikis 的样式:文档存储在第三方平台上. REA…