使用docsify 写开源文档

【使用docsify 写开源文档】的更多相关文章

使用docsify 写开源文档

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

使用开源文档工具docsify，用写博客的姿势写文档

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

这些.NET开源项目你知道吗？.NET平台开源文档与报表处理组件集合(三)

在前2篇文章这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧和这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧!(第二辑)中,大伙热情高涨.再次拿出自己的私货,在.NET平台处理文档相关的开源组件.文档处理在开发中是一个非常常见的任务了,例如导出Excel,导出Word,生成PDF报表等等.那今天就看看下面这些.NET开源项目你知道不?如果有用,千万不要忘记推荐哦.同时个人能力有限,希望大家补充. .NET开源目录:[目录]本博客其他.NET开源项目文章目录本文原文地…

拯救你的文档 – 【DevOps敏捷开发动手实验】开源文档发布

今天上海的天气真是不错,风和日丽.再次来到微软上海紫竹研发中心,心情很是愉快,喜欢这里的大草坪,喜欢这里的工程气氛,更喜欢今天来陪我的小伙伴们. 这次动手实验培训与以往最大的不同就是采用了开源文档的方式.其实,小编一直在寻找一种更好的技术文档编写方式.说到文档,我在过去的几年中也写了不下500份不同类型的文档.我估计,每个写过技术文档的同学都有类似这样的文件夹. 是不是很有一种蛋疼的感觉,没有办法啊,需求改来改去,客户的要求变来变去 … … 最后么,就没有最后了,你就自己苦逼去吧. 所以,自从开…

.NET平台开源文档与报表处理组件包括Execel PDF Word等

在前2篇文章这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧和这些.NET开源项目你知道吗?让.NET开源来得更加猛烈些吧!(第二辑)中,大伙热情高涨.再次拿出自己的私货,在.NET平台处理文档相关的开源组件.文档处理在开发中是一个非常常见的任务了,例如导出Excel,导出Word,生成PDF报表等等.那今天就看看下面这些.NET开源项目你知道不?如果有用,千万不要忘记推荐哦.同时个人能力有限,希望大家补充. .NET开源目录:[目录]本博客其他.NET开源项目文章目录本文原文地…

你会用AngularJS，但你会写AngularJS文档么？

你会用AngularJS,但你会写AngularJS文档么? 涉及知识:gulp javascript 我们经常在写代码的时候要求写好注释,方便日后维护.但其实注释还有一个重要的用途:生成API文档. 文档意义 API文档有什么用?避免多人开发时出现重复造轮子(轮子都在文档上).方便新加入项目的开发人员了解公用函数/组件.方便所有开发人员查阅公用函数/组件的入参和出参以及调用方式.... 实际问题前端API文档生成有著名的工具jsdoc.公司项目采用gulp构建工具和AngularJS的框架,…

《Spring Boot 实战纪实》之如何攥写需求文档

目录前言 (思维篇)人人都是产品经理 1.需求文档 1.1 需求管理 1.2 如何攥写需求文档 1.3 需求关键点文档 2 原型设计 2.1 缺失的逻辑 2.2 让想法跃然纸上 3 开发设计文档 3.1 功能梳理 3.2 数据库设计 4 制定开发任务和计划 4.1 时间管理 4.2 任务管理(任务拆分+排期) (技术篇) 码农的自我修养 5 Java基础 5.1 Java环境搭建 5.2 Java基本语法 5.3 Java流程控制 5.4 Java 集合 5.5 Java 类与对象 5.6 构…

开源文档管理系统LogicalDOC测试报告---安装篇

开源文档管理系统LogicalDOC测试报告---安装篇分类: Linux2011-06-22 15:40 7436人阅读评论(3) 收藏举报文档管理测试mysql数据库installerjava 开源文档管理系统 LogicalDOC 测试报告 --- 安装篇一. 软件需求: JDK1.6 MySQL(支持 INNODB引擎 ) 二. 安装步骤: 1. JDK的安装 JDK 可以在官方网址 http://www.oracle.com/technetwork/java/javase/d…

【DevOps敏捷开发动手实验】开源文档 v2015.2 stable 版发布

Team Foundation Server 2015 Update 2版本终于在2周前的//Build 2016大会上正式发布了,借这个东风,小编也完成了[DevOps敏捷开发动手实验]开源文档的第一个正式版本v2015.2 文档地址:http://docs.devopshub.cn/docs/vsalm-hols/ 这套文档针对不同类型的人员提供了各自适合的内容: IT研发管理人员 Visual Studio ALM概述:适合IT研发管理人员阅读,通过横向比较业界流行的几种ALM/DevOp…

看云&gitbook 写帮助文档 | 专注于文档在线创作、协作和托管

看云写帮助文档 | 专注于文档在线创作.协作和托管 https://www.kancloud.cn/manual/thinkphp/1678 https://www.gitbook.com/…

「快学springboot」16.让swagger帮忙写接口文档

swagger简介官方的介绍 THE WORLD'S MOST POPULAR API TOOLING Swagger is the world's largest framework of API developer tools for the OpenAPI Specification(OAS), enabling development across the entire API lifecycle, from design and documentation, to test and…

有了Swagger2，再也不用为写Api文档头疼了

1.为什么要写Api文档现在,前后端分离的开发模式已经非常流行,后端开发工程师只负责完成后端接口,前端页面的开发和渲染完全由前端工程师完成. 问题来了,前端工程师怎么知道后端接口的具体定义呢?答案是由后端工程师撰写. 2.写Api文档很头疼吗答案是一定的,这对后端工程师来说,是额外的工作,编码已经很耗费精力了,这时前端工程师来催文档,不头疼才怪:),当然这也不是前端工程师的问题,都是为项目的进度着急. 3.Swagger2 现在好了,一个自动撰写Api文档的神器出现了,他就是 Swagger…

C#写TXT文档

//C#写TXT文档 String strDir = System.IO.Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().GetName().CodeBase); string filePath = strDir + "\\putin.txt"; FileStream fs = new FileStream(filePath, FileMode.Append); StreamWriter s…

springboot 集成 docsify 实现随身文档

需求分析文档可以和项目一起进行版本管理文档可以在线访问文档可以与springboot项目集成,不需要分开部署 MarkDown支持文档跟随,打包jar也可以访问技术选型对于网上已有的方案,大致分为如下几种将文档部署在 resource静态资源目录下,用模板渲染访问.$^{[1]}$ 分离部署,打包 jar后还需要单独上传静态资源文档内容并部署. 最终选定的技术方案如下工具用途官网 Typora 文档编写 https://typoraio.cn/ Docsify 文档部署…

要写文档了，emmm，先写个文档工具吧——DocMarkdown

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

用docsify快速构建文档，并用GitHub Pages展示

什么是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>…

如何写Java文档注释(Java Doc Comments)

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

Markdown写接口文档，自动添加TOC

上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown基本语法也没啥好说的,随便百度一下几分钟看懂基本的,20%的知识完成80%的任务嘛,够了. 关键在于,我有些特殊需求,以方便将Markdown作为接口文档查看.什么需求呢? 目录.这是重中之重.没有方便的TOC的话,文档长了,查看起来真是费劲.我理想中的目录是这样的: 根据H1(# ).H2(## …

Perl：写POD文档

官方手册:https://perldoc.perl.org/perlpod.html POD文档是perl的man文档,可以用perldoc输出,也可以直接用man输出.在开始下面的文章之前,请先粗略浏览一到两篇perldoc文档,或去CPAN找几个模块的文档浏览下大致格式. 例如: $ perldoc Data::Dumper $ man Data::Dumper 执行perldoc的时候,perldoc会搜索@INC下的Data/Dumper.pm和Data/Dumper.pod文件. PO…

Windows7下使用sphinx生成开源文档（原）

作者这里以osgearth文档为例,感觉这种生成文档的方式比较好,生成的html文档是支持搜索的,感谢开源工作者的奉献.赞一个 1. 下载并安装python for windows:https://www.python.org/downloads/windows/ 2.下载安装setup tools下载easy_stall.py 并运行https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install,可以找到window…

用atom写LaTeX文档

下载并安装Tex Live: 下载页面下载并安装atom:下载页面打开atom File -> Settings -> Install 搜索并安装: language-latex latex pdf-view 新建文件,后缀名为.tex,编码为UTF-8 测试: \documentclass[UTF8]{article} \author {Author} \title {Title} \usepackage{ctex} \usepackage{amsmath} \usepackage{am…

chm开源文档制作

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

开发API完成，写个文档

Jira对接Prism开发API指南部门证系统运维团队文档制作人陈刚() 时间 2017-04-05 版本第一版目录目的... 1 通例:... 1 认证... 2 新建版本单... 2 获取指定版本单的发布单信息... 3 目的为了提升工作效率,打通jira和prism之间的联系,让软件项目管理人员可以在jira上新建版本单,并跟踪发布进度,特在prism上制作相关API供jira调用. 通例: l Prism的web址会因环境不同或构架变更而发生变更,jira端须提供自…

c#写word文档基础操作（自己控制样式）

下面一个函数,建立一个Word 文档,添加页眉.页脚,在内容中两个不同字体的Hello!!! 来自 <http://bbs.csdn.net/topics/340041961> public void myFunction() { Word.ApplicationClass oWordApp = new Word.ApplicationClass(); //建立Word 对象,启动word程序 object missing = System.Reflection.Missing.Value…

手写OOXML文档——导出xlsx格式表格文档

一.准备工作: 2个js库,另外把样式文件抽离出来 require('file-saver'); import JSZip from 'jszip' import {stylesData,theme1Data} from './xlsxStyles' 转换成OOXML文档: 新建“工作簿1.xlsx”,修改后缀.zip,得到如下目录结构: 内容.属性文档目录:content_Types <?xml version="1.0" encoding="UTF-8"…

几个方便的基于es 的开源文档索引系统

Apache Tika 比较有名的内容提取工具 FsCrawler 使用java 开发,内部使用了Tika Ambar nodejs,python应用开发,轻量,支持基于docker 的快速部署,同时支持各种文档类型,ocr.... 参考资料 https://ambar.cloud/blog/2017/10/24/ingesting-documents-into-es/ …

Java 从基础到进阶学习之路---类编写以及文档凝视.

Java之前在学习过,基础知识还没有忘光,并且这些高级语言实在是太像,所以那些数据类型,或者循环控制流,以及标准设备等等就直接略过不说了. 只是一些重大概念会穿插在文章的介绍中. So,这些文章适合于那些有一定高级面向对象语言基础的人阅读. 我们首先编写一个学生类.其主要要求要熟悉的内容是: 关于类构造器(构造方法)的认识和理解. 关于方法的编写. 关于成员变量 & this 的使用, 熟悉了这些内容后,我们就能够依照以下的类图编写这个类了. 构造器的參数有姓名,性别,学号. 类图例如以下: w…

与你相遇好幸运，aglio写接口文档

npm install -g aglio npm i aglio-theme-minimal aglio --theme-full-width -t minimal -i ./src/index.md -o index.html FORMAT: 1AHOST: http://123.56.205.244:8602/event/ # Common Demo Interface Plan后端 `Demo` 通用接口计划 # Group Event Manage农事管理 ## Event [/even…

开源文档管理工具Joomla的网站安装

1.配置PHP开发环境(Apache.PHP.MySQL) 2.安装Joomla网站: 1. 下载安装包 http://www.joomla.org/download.html 2. 登陆Joomla安装包中的index.php的页面开始安装 2. 安装步骤按照网站浏览器安装步骤 http://help.joomla.org/content/view/1947/302/1/8/ 3. 安装finish后,删除Joomla安装包中的installation文件夹: 4.点击websi…

应用程序写Xml文档

主要用到CreateElement.CreateTextNode.CreateComment.AppendChild.InsertAfter方法代码如下: XmlDocument document = new XmlDocument(); document.Load("XmlReader.xml"); //Get the root element XmlElement element = document.DocumentElement; //Create new nodes Xml…