0.Confluence简介 Confluence是一个企业级的Wiki软件,可用于在企业.部门.团队内部进行信息共享和协同编辑. 1.基础概念 Confluence的使用并不复杂,只需掌握如下几个基础概念. 空间(Space) 空间是Confluence系统中的一个区域,用于存储wiki页面,并可实现对空间中的所有文档进行统一的权限管理. 通常,我们可以针对每个项目单独创建一个空间,然后将与该项目相关的文档信息放置到该空间中,并只对项目成员开设访问/编辑权限. 除了项目空间,每个成员都有一

作者:吴香伟 发表于 2014/08/07 版权声明:可以任意转载,转载时务必以超链接形式标明文章原始出处和作者信息以及版权声明 本文不讲解Markdown的语法规则,只关注它带来的好处以及我使用的方法.语法规则可以参考Markdown: Syntax. 文档内容和格式分离 使用Word写文档总花费很多时间在调整格式,并且往往最终也没让自已满意.这对有洁癖的人来说痛苦非常.Markdown只通过几个简单的符号表示文档的格式,比如##代表二级标题,**X**代表强调内容X,*X*代表X的字体为斜体

ToShowDoc拯救不想写文档的你 写注释已经够折磨开发者了,显然天天curd的我们再去写文档岂不是分分种要被逼疯. 我想每个人都有这种经历 加了一个参数文档忘了更新 参数名更改文档忘了更新 删掉一个接口文档忘了更新 ....... 各种忘了更新 已经有Swagger的我们慢慢的已经忘掉了写文档这件事. 但是在某些不方便暴露swagger地址的那天,又回忆起被文档支配的恐惧. What is ToShowDoc showdoc是一个文档供应商,它提供了一个良好的结构易于开发者编写文档. 也提供

​ 作为一个开发人员最怕的就是写文档了,但是要想成为一个合格的程序员,写好文档也是一个必备的技能.开发中我们经常要写接口服务,既然是服务就要跟别人对接,那难免要写接口文档,那么如何”优雅“的写接口文档呢?本文介绍一个在写代码的过程就可以写完接口文档的工具——Swagger2(江湖人称丝袜哥

前提 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 docsify是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBook.Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时.如果你想要开始使用他,只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages(码云Pages.阿某云OSS或者鹅云COS等等).它的主要特性如下: 无需构建,写完文档直接发布(运行时markdown文

前言 每次开发完新项目或者新接口功能等,第一件事就是提供接口文档.说到接口文档,当然是用 Markdown 了.各种复制粘贴字段,必填非必填,字段备注,请求返回示例等等.简直是浪费时间哇.所以想到了开发一款插件来解决重复复制文档的问题.下面来看我介绍介绍这款插件. PS:插件比较简陋,还需要不断迭代. 公众号:liuzhihangs,记录工作学习中的技术.开发及源码笔记:时不时分享一些生活中的见闻感悟.欢迎大佬来指导! 为什么开发插件 每次在对外提供接口时都要写文档,各种麻烦,并且文档耗费了很大

首先,第一步我们需要执行以下的命令来安装字体管理工具:  yum install -y fontconfig mkfontscale 然后我们到(Windows系统)“c:/windows/fonts”(先把fonts文件夹全部复制出来,再传输到centos)中把我们需要的字体拷贝出来到 /usr/share/fonts/ 目录 也可以在fonts 下创建个放字体的文件夹 然后依次执行: mkfontscale mkfontdir fc-cache -fv  我执行到这一步直接去confluen

转载于:http://blog.csdn.net/xiahouzuoxin/article/details/19752603 Markdown是一种网络书写语言,其目标是实现易读易写,且兼容HTML语言.Markdown的流行得益于Github和Stackoverflow,Stackoverflow的代码块以及Github上的README.md文件格式都是通过Markdown表现的.从这里您可以很直观的看到Markdown的效果:https://github.com/adam-p/markdow

Sphinx 是一个工具,它使得创建一个智能而美丽的文档变得简单.作者Georg Brandl,基于BSD许可证. 起初为写 Python 文档而诞生的 Sphinx,支持为各种语言生成软件开发文档. 它有着以下突出特性: 输出格式:HTML(包括Windows的HTML帮助文件).LaTex(可以打印为PDF).epub(流行的电子书格式).Texinfo.manual pages(man手册).plain Text(纯文本) 广泛的交叉引用:语义标记,函数.类等的自动连接等 分层架构:目录树

本文主要参考资料为该网址:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md 如何想使用现成的gitbook,网络上虽说可以搜索的到,但是要使用,可能会受到限制,需要翻墙. 但是通过这种方式,就不必翻墙,可以作为公司内部文档或者是自己的开源项目介绍等. 步骤如下(以生成一个blog文档为例): 全局安装gitbook-cli npm install gitbook-cli -g 初始化 gitbook init ./blo

导航 前言 离线文档 1 保存为html 2 导出成pdf文档 3 导出成Word文档 参考 前言   早前笔者曾经写过一篇文章<研发团队,请管好你的API文档>.团队协作中,开发文档的重要性,这里就不再赘述,今天的话题集中在如何进一步提升更加高效的使用文档. 离线文档   swagger已经很方便了,我们为什么还需要离线文档?公司同一个项目组,一般只要集成了swagger基本就够了,但是难免会有跨组,甚至会有公司对外合作的项目.特别是在"微服务大行其道的今天",多个团队之

一. 思路 今天接到个小任务,让把json文件转换成excel文件,按照列展开. 思路:既然json已经都已经是现成的,那直接将json文件做读操作,在通过不同的key,找到对应的信息,在存到单元格中,在写操作,生成excel文档 二.jar包 涉及到的jar包,阿里的fastjson和poi的jar包 三.代码 我的json文档里数据的格式是这样的 [ { "total": 1, "name": "规则限制:XXXX", "timeS

前言 之前想用Markdown来写框架文档,找来找去发现还是Jekyll的多,但又感觉不是很合我的需求 于是打算自己简单弄一个展示Markdown文档的网站工具,要支持多版本.多语言.导航.页内导航等,并且支持Github Pages免费站点 组件选择 我自己呢比较喜欢C#,恰好现在ASP.Net Core Blazor支持WebAssembly,绝大部分代码都可以用C#完成 对于Markdown的分析,可以使用markdig组件(有个缺点,目前它把生成Html的代码也放到了程序集里,增加了不少

package apache.poi; import java.io.ByteArrayInputStream;import java.io.ByteArrayOutputStream;import java.io.File;import java.io.FileInputStream;import java.io.FileOutputStream;import java.io.IOException;import java.io.OutputStream;import java.util.Ha

vuepress的官方文档:https://vuepress.vuejs.org/zh/guide/ 参考:https://segmentfault.com/a/1190000016333850 https://juejin.im/post/5d1f1136f265da1ba77cc3d3 https://juejin.im/post/5d1ab9c151882579dd60d5e0 视频教程:https://www.bilibili.com/video/av78052346?p=2 搭建一个v

1.找一个文档规范要求. 2.根据文档的规范要求调整正文的格式,标题1的格式,标题2的格式,标题3的格式,图表的格式,把没用的那些格式都删除掉. 3.图注表注后空格一行. 4.设置页眉页脚. 5.生成一个目录.

相对于添加组件后再进行调整和赋值,通过复制和粘贴已有游戏组件能够带来更高的效率.

1. 段落和标题大纲 标题大纲(类似于HTML的H1, H2, …) 简单得很,一级标题用# 标题, 二级标题用## 标题,三级标题用### 标题,以此类推. 段落(类似HTML的<p>)标签 连续的2个回车表示一个段落.就这么简单 2. 无序列表和有序列表 无序列表每个每个列表项用*开头 有序列表每个列表项用1., 2., ……这样的开头 tab表示缩进一个层级,可以实现列表的嵌套. 3. 强调和斜体 *我是斜体*这样就是表示一个斜体: 我是斜体 **我是粗体**这样就表示一个粗体:我是粗体

本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主要探讨应该如何去写文档注释 业余时间整理,难免有遗漏或错误,如有发现欢迎指正 转载请注明 文档注释概览 “文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释,它是一种带有特殊功能的注释. 文档注释与一般注释的最大区别在于起始符号是/**而不是/*或/

使用docsify 写开源文档 官网:https://docsify.js.org/#/ docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件"污染" commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages. 一.初始化

本文大部分内容翻译总结自<Software Engineering at Google> 第10章节 Documentation. 另外,该书电子版近日已经可以免费下载了 https://abseil.io/resources/swe_at_google.2.pdf,有兴趣的同学可以下载翻阅下. 首先声明,本问所说的文档不仅限于纯文本文档,还包含代码注释(注释也是一种特殊形式的文档). 很多技术人自己非常轻视技术文档的书写,然而又时常抱怨文档不完善.质量差.更新不及时-- 这种在程序猿间普遍存