为什么不使用github的wiki而是使用mkdocs做文档管理? 目前 KSFramework 是使用mkdocs来做在线文档 而非使用github的wiki,这是为什么呢? 在windows下搭建wiki本地预览不成熟 gollum:https://github.com/gollum/gollum A simple, Git-powered wiki with a sweet API and local frontend. (一个简单的支持git wiki,提供本地预览) 在gollum的说…

简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介 类别:项目文档生成器,生成静态站点,管理MarkDown文档. 官方网址:http://www.mkdocs.org/ 中文文档:http://m…

导读 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程…

http://www.mkdocs.org/  api接口文档编写 ,效果非常不错…

这里是总结了一下,用的工具或者平台:readthedocs.github .sphinx. 使用这三个工具即可轻松创建高效的文档管理库,可以用来翻译,水平再高一点可以写书. readthedocs 文档托管的平台,能够和常用的GIT阵营的github,HG阵营的Bitbucket,关于这两个平台的讨论比较文章可以参考. github 代码托管 sphinx 文档书写利器,使用的是reStructuredText格式,reStructuredText简明教程. 下面说说书写方法及托管流程 在这里注…

亲们支持我的新博客哦==>地址(以后更新会尽量在新博客更新,欢迎大家访问加入我的后宫w) ) 平时都是写readMe和docs的,一直眼瞎没有注意到有wiki这个功能 随便找一个写了wiki的看一下,效果还是不错的==>weUI 开启wiki ​ github的wiki项目默认是开启的,如果你的没有这个选项卡可能是关闭了,在setting中开启==> wiki是可以随时开启和关闭的,并且关闭后再开启是有保存以前的内容的 创建页面 现在还是空的,点击绿的按钮创建页面(无视我的歌词展示,最近…

developer.apple.com 英文搜索各个技术的官方介绍文档, 前提是英文过关 cocoachina ios最新新闻, 信息 code4app上有许多组件 http://www.code4app.com github上什么都有, 主要是使用搜索引擎进行英文搜索 http://www.github.com 比如图片浏览器 就输入关键字: photo browser 比如数据库/sqilte 就输入关键字: sqlite database orm 等关键字 cocoapods 主要是管理第…

The easiest way to use Bluetooth (BLE )in ios,even bady can use. 简单易用的蓝牙库,基于CoreBluetooth的封装,并兼容ios和mac osx. 为什么使用它? 1:基于原生CoreBluetooth框架封装的轻量级的开源库,可以帮你更简单地使用CoreBluetooth API. 2:CoreBluetooth所有方法都是通过委托完成,代码冗余且顺序凌乱.BabyBluetooth使用block方法,可以重新按照功能和顺序…

使用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…

版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/zhangdaiscott/article/details/80 JEECG 新版在线文档WIKI正式发布   背景:  jeecg 从2013年开源至今经历了6年时间,由于时间长迭代版本多,jeecg一直存在文档更新不及时,文档不匹配的问题.为了解决这个问题,jeecg 从3.7.3版本开始正式推出在线手册wiki,不再提供pdf技术文档,统一文档入口. 由于文档刚刚推出,有不匹配或描述不清的地方…

简介 MkDocs 可以同时编译多个markdown文件,形成书籍一样的文件.有多种主题供你选择,很适合项目使用. MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档.文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置. 官方快速开始 https://squidfunk.github.io/mkdocs-material/getting-started/ 本人整理的快速开始 首先安装python // 安装 pip install mkdocs // 安装后查…

简介 Type-safe HTTP client for Android and Java by Square, Inc. GitHub主页:https://github.com/square/retrofit/ WIKI    官网&简易教程 JAR包 系列教程 [配置依赖与混淆] Retrofit requires at minimum Java 7 or Android 2.3. Snapshots of the development version are available in S…

MinDoc是什么? MinDoc是一个在线的文档管理系统,该系统适用于团队.个人等使用.开发者最初的目的是为了便于公司内部使用,仿照看云开发.有laravel版本以及golang版本.不过laravel版本部署起来相当麻烦,因为到搭建PHP开发环境还需要自己配置,加上精力有限,暂停了laravel的研发.本文中用golang版本介绍如何安装,安装教程其实在GitHub是有的,但是在安装中,发现作者有几个地方写的不够完善,特此记录此文. 如何获取MinDoc 官网,github,wiki,代码下…

由于是英文文档,不做笔记过一阵就忘了,现在把关键点记录到这,开发的时候使用. 具体wiki地址:https://github.com/facebook/rocksdb/wiki 1)Column Faimilies 意味着可以将写入的key进行逻辑分组存储,不影响读取,若未指定则使用default: 2)MemTable 在内存中存储的数据,当达到一定的条件时会flush到文件: memtable_factory: The factory object of memtable. By speci…

日前,GitHub 文档的简体中文正式发布,开发者可以到官方文档上随意查阅浏览中文文档啦!   对于想要玩 GitHub,但一直苦于英语水平较差的程序员来说,这真是一个天大的好消息.下面一起来感受一下中文文档吧     是不是瞬间觉得 GitHub 变的十分接地气了呢,而且无论你是初级入门,还是中高级选手都适用哦~   其中,GitHub 企业版帮助文档也上线了,用户可根据具体需求点击"管理员指南"或"用户指南"来查看详细内容.   企业版涵盖管理员指南和用户指南:…

从本文开始,我将专门开辟一个Github Code系列,开源自己写的一部分有意思而且实用的demo,共同学习.以前都发布在git OSChina上,后面有空会陆陆续续整理到Github上.OSChina最大的优点是可以免费托管私有项目,服务器在国内速度快,这些是Github所比不了的.不过Github优势在于开源氛围浓烈,有利于向各位开源大牛学习交流.长话短说,just do it! 本文只要实现随滚动实时模糊(或称为动态模糊)的效果(请见文章末尾处),这种效果被广泛应用于各大天气类APP中,如…

文档注释,无非“//”和“/**/”两种 ,自己写代码,就那么点,适当写几句就好了:但是一个人总有融入团队的一天,团队的交流不是那几句注释和一张嘴能解决的,还需要通用的注释标准. PHPDoc是PHP文档注释的一个标准,可以帮助我们在注释文档时有规范,查看别人的代码时更方便.下面的表格是我翻译的WIKI上的PHPDoc,个人英文水平有限,可以参照原文. 文档翻译自:http://en.wikipedia.org/wiki/Phpdoc 标记 用途 描述 @abstract   抽象类的变量和方法…

Jeecg社区wiki在开放,最终能够在线看文档啦! .! 2014-12-18 scott JEECG jeecg开源社区wiki正式启动了.方便大家看文档 訪问地址是: http://osbaba.com:8002/display/12/Home 大家能够点击以下的阅读原文进入该链接哟 产品介绍 技术文档 用户指南 jeecg工作流高速开发平台 easypoi文档 jeecg数据权限操作手冊 jeewx(捷微)微信管家系统 jeecg3.4-maven入门-eclipse jeewx-cms…

一 .git的安装 windows下面的安装:https://git-for-windows.github.io  从这里下载完全无脑安装. 安装完成后,在开始菜单里找到"Git"->"Git Bash"  表示安装成功. 之后,在命令行输入: $ git config --global user.name "Your Name" $ git config --global user.email "email@example.co…

有两种编写方式: In reStructuredText In Markdown In reStructuredText  工具:  pip install sphinx sphinx-autobuild 克隆你的仓库到本地:  git clone https://github.com/yourusername/yourrepository.git 在仓库根目录内创建文档: mkdir docs & cd docs sphinx-quickstart //按照提示一路下去,会生成index.rs…

word文档作为产品文档的问题: word文档本身的设计是为了打印: word文档的编辑较为繁琐: 作为产品文档的word文档往往长达百页以上,难以维护,且容易分散注意力,不利于查阅: 没有一个简单易用的搜索机制: 文档更新后的发布共享过程比较低效 Wiki作为产品文档的优势: wiki的内容是大家都可以编辑的,方便各种信息的聚合: wiki的内容是修改后直接呈现的,方便共享: wiki的内容基于Web页面的,各主题独立,查阅时不容易分散精力: 一般都会有良好的搜索机制(搜索主题或内容,列出相关…

mkdocs是Python的一个对 Markdown 友好的文档生成器.,小巧精美. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YA…

前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程…

最近在学 Python,所以总是在看 Python 的官方文档, https://docs.python.org/2/ 因为祖传基因的影响,我总是喜欢把这些文档保存到本地,不过 Python 的文档实在是太多, 根本存不过来.后来追踪到 Python 官方的 GitHub 文档地址, 干脆就把官方的 GitHub 下载下来了:cpython GitHub 地址. 1. 下载 Python 的 GitHub 仓库:cpython从 GitHub 上 clone 仓库很简单,在命令行中执行命令 gi…

今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓教科书式,不外如此.原文是英语,大神可直接看戳我查看.下面是我翻译的中文版(未完全按照原文翻译),献丑了. 项目名称 这里再写一句骚气又精准的话描述你的项目吧. 上手指南 写几句这样的话概括接下来的内容:以下指南将帮助你在本地机器上安装和运行该项目,进行开发和测试.关于如何将该项目部署到在线环境,请…

相比ElasticSearch,Solr的文档详尽丰富,同时也显得冗余啰嗦. Solr的官方文档有两个地方: Solr官方教程 Solr社区维基 本文主要列出一些Solr Wiki中的主要讨论主题,方便查阅: SolrJ 主要讲解Solr Java客户端的使用方法,版本比较老. SolrSchema.xml 主要讲解SolrSchema.xml相关配置. Solr中文分词 Solr自带多语言分词工具,主要是CJKTokenizer和SmartChineseTokenizer,基本上跟Lucene…

什么是docsify 无需构建,写完 markdown 直接发布成文档,写说明文档的极佳选择. 快速上手 安装 npm i docsify-cli -g docsify init docs 创建项目 新建一个空项目,接着创建一个 docs 目录并进入到 docs 目录下 mkdir my-project && cd my-project mkdir docs && cd docs 创建入口文件 根目录下创建index.html 文件 <!DOCTYPE html>…

在听了测试的一通唠叨之后,"内部实现一堆逻辑,只有一句话的需求文档","文档那么简单,我们怎么测试啊",心中突然想起来自己曾经干的一件当时觉得还不错的事情,但是事后想起来,可能比较二的决定,当时在做一个类似原型的产品,那时候的问题就是时间很短,需求根本就写不完,研发测试时间也都是很短,于是当时就决定协作写需求文档,也就是产品经理先给大家讲解一下整体的产品功能,细节的地方没有讲的很透彻.然后在Wiki上先写一个大概的需求,细节的地方,由开发一边开发,一边在和产品经理沟…

自己初次接触GitLab,通过百度和自己查找资料,了解了一部分.在自己的工作中,主要用到GitLab的Wiki文档版本管理能力.我总结了一小部分文本编辑需要用到的东西. 一.文本的排版 为了让文本/文档的结构清晰明了,我们需要一下标题结构和文本格式.Wiki 主要的文本编辑语法用到的是Markdown.Markdown语法兼容HTML,可以直接在文档里用HTML撰写,只是有一些区块元素<div><table><pre><p>等标签,必须在前后加空行与其他内容…

Markdown 和 MkDocs 简介 Markdown 的语法简洁明了.学习容易,而且功能比纯文本更强,因此有很多人用它写博客.世界上最流行的博客平台 WordPress 和大型 CMS 如 Joomla .Drupal 都能很好的支持 Markdown . MkDocs 是一个用于创建项目文档的快速,简单的静态站点生成器.文档源码使用 Markdown 来撰写,用一个 YAML 文件作为配置文档. MkDocs 处理的是一系列的 Markdown 文档,然后将 Markdown 文档的内容…