【DocFX文档翻译】DocFX 入门 (Getting Started with DocFX)

DocFX 入门 1. DocFX 是什么? DocFX 是一个基于.NET的API文档生成器,当前支持 C# 和 VB. 它可以通过你的代码中的三斜杠注释生成 API 参考文档.同样也支持你使用 Markdown 文件创建一些其他的主题文档(例如:教程以及使用手册).以及自定义生成的参考文档. DocFX 会使用你的代码以及 Markdown 文件生成一个静态的 HTML 网站.你可以将它轻松的部署到任何web 服务器(例如: github.io).同样的 DocFX 也提供扩展性,允许你通过…

Kinect帮助文档翻译之一入门

最近在玩Kinect,使用的是Unity,发现网上好像没有什么教程.自己就只有抱着英文版帮助文档啃,真是苦逼本人英语也不好,大家将就着看吧 Kinect入门帮助如何运行示例 1 下载并安装Kinect v2 SDK,详情将在下一节中描述. 2 打开场景“KinectAvatarsDemo”,位于Assets/AvatarsDemo文件夹 3 运行场景.移动身体来观察两个Avatar(正常和镜像)以及CubeMan是如何反映你的动作的 4 使用你…

Docker官方文档翻译之入门

转自:http://www.cnblogs.com/vikings-blog/p/3958091.html Docker学习总结之docker入门 Understanding Docker 以下均翻译自Docker官方文档 ,转载请注明:Vikings翻译. What is Docker? Docker 是一个开源的平台,设计目标是可以方便开发,方便部署和方便执行应用.使用docker可以快速分发开发好的应用.借助于Docker,你可以将开发平台和应用分离开,并且像管理应用一样管理开发平台.Do…

TensorFlow文档翻译-01-TensorFlow入门

版权声明:本文为博主原创文章,转载请指明转载地址 http://www.cnblogs.com/junyang/p/7429771.html TensorFlow入门英文原文地址:https://www.tensorflow.org/get_started/get_started 这是关于如何开始tensorFlow的指南.开始之前,你需要先安装TensorFlow.除此之外,你应该了解: 知道如何使用Python编程. 懂一点点数组如果具有机器学习的知识则更好.当然,如果你没有学习过机器学…

React文档翻译 (快速入门)

翻译自react的大部分文档,方便自己查阅. 目录生命周期实例化存在期销毁期 state Do Not Modify State Directly State Updates May Be Asynchronous State Updates are Merged The Data Flows Down 条件渲染(Conditional Rendering) 使用&&操作符替换if 使用?:替换if else Preventing Component from Rendering…

使用DocFX生成文档

使用DocFX命令行生成文档使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用创建初始项目 docfx init -q 此命令生成一个名为docfx_project的默认项目. 3.生成网站 docfx docfx_project\docfx.json --serve 现在你可以访问http://localhost:8080查看生成的网站.使用 -p 端口可以指定端口. API文档将编写的项目复制到docfx_pro…

docfx （一）

什么是docFX? DocFX 是一个基于.NET的API文档生成器,当前支持 C# 和 VB.它可以通过你的代码中的三斜杠注释生成 API 参考文档.同样也支持你使用 Markdown 文件创建一些其他的主题文档(例如:教程以及使用手册).以及自定义生成的参考文档.DocFX 会使用你的代码以及 Markdown 文件生成一个静态的 HTML 网站.你可以将它轻松的部署到任何web 服务器(例如: github.io).同样的 DocFX 也提供扩展性,允许你通过模版自定义网站的布局和样式.…

DocFX生成PDF文档

使用DocFX生成PDF文档,将在线文档转换为PDF离线文档. 关于DocFX的简单介绍使用DocFX生成文档使用docfx 命令 1.下载 https://github.com/dotnet/docfx/releases 2.使用创建初始项目 docfx init -q 此命令生成一个名为docfx_project的默认项目. 3.生成网站 docfx docfx_project\docfx.json --serve 现在你可以访问http://localhost:8080查看生成的网站.…

docfx chocolatey安装方法

这两天在git下载的docfx.zip .在安装过程中总是闪退,而加入环境变量后,执行提示:config file docfx.json does not exist.所以我选择chocolatey 安装方法. 一首先安装chocolatey工具 1.打开cmd命令输入一下命令@powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadStrin…

使用 DocFX 生成 .Net/Unity项目文档

孙广东 2017.5.27 http://blog.csdn.NET/u010019717 微软开源全新的文档生成工具DocFX 类似JSDoc或Sphinx 如何使用看 : http://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站. 比如我的测试使用的Unity UGUI 的源代…

docfx 简单使用方法、自动生成目录的工具

[摘要] 这是我编写的一个 Docfx 文档自动生成工具,只要写好 Markdown 文档,使用此工具可为目录.文件快速生成配置,然后直接使用 docfx 运行即可. https://github.com/whuanle/CZGL.DocfxBuild.Yml/releases/tag/1.0 一,安装Docfx 下载地址 https://github.com/dotnet/docfx/releases 下载后解压压缩包,记录好目录路径. Win 搜索 “环境变量”,会出现 “编辑系统环境变量”…

.NET6使用DOCFX自动生成开发文档

本文内容来自我写的开源电子书<WoW C#>,现在正在编写中,可以去WOW-Csharp/学习路径总结.md at master · sogeisetsu/WOW-Csharp (github.com)来查看编写进度.预计2021年年底会完成编写,2022年2月之前会完成所有的校对和转制电子书工作,争取能够在2022年将此书上架亚马逊.编写此书的目的是因为目前.NET市场相对低迷,很多优秀的书都是基于.NET framework框架编写的,与现在的.NET 6相差太大,正规的.NET 5学习教…

入门干货之用DVG打造你的项目主页-Docfx、Vs、Github

由于这三项技术涉及到的要点以及内容较多,希望大家有空能自己挖掘一下更多更深的用法. 0x01.介绍 VS,即VS2017以及以上版本,宇宙最好的IDE,集成了宇宙最有前景的平台,前阶段也支持了宇宙最好的语言. Github,知名的代码/项目托管平台,不想赘述了,如果干两三年了这个都不认识,自觉转行吧,我不在文章里说什么,但你得晓得,我肯定偷偷的鄙视你了. Docfx,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,Do…

好代码是管出来的——C#的代码规范

代码是软件开发过程的产物,代码的作用是通过编译器编译后运行,达到预期的效果(功能.稳定性.安全性等等),而另外一个重要作用是给人阅读.对于机器来说只要代码正确就能够正确的运行程序,但是人不同,如果代码编写混乱就会对代码阅读造成障碍,导致代码无法维护,甚至会导致代码重构等高成本活动,所以规范代码势在必行. 本文从以下几个方面介绍代码规范以及相关工具. .Net代码规范简介代码格式规范命名规范布局规范注释规范代码使用规范常用的代码规范工具小结 .Net代码规范简介文章开始提到过代码是…

docfx 做一个和微软一样的文档平台

开发中,有一句话叫最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档.那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档? 实际上微软有工具用来生成 api 文档和教程. 我这里说的微软文档是:https://docs.microsoft.com/en-us/dotnet/articles/csharp/index 这个网站,不是以前的. 微软文档使用的工具是 docfx ,这是一个很好的工具. 本文将告诉大家如何使用这个工具做出和微软一…

微软开源全新的文档生成工具DocFX

微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create custom template. 源代码…

docfx组件介绍--MarkdownLite

在docfx中,最重要的就是生成文档,把markdown文件(gfm语法)转换成html. 为了这一步,我们找了N个.net开源项目,发现要么是common markdown的,要么不容易扩展,没有一个是基于gfm的并且很容易扩展的语法的markdown开源项目.无奈之下,再找.net下执行js的engine,结果发现要么用jint这个解释engine慢慢跑,要么就不能跨平台,或者就各种问题.哎,真是让人抓狂啊... 走投无路之下,还是自己写一个吧,把marked.js的逻辑先翻译一遍,参考了各…

docfx组件介绍--YamlSerialization

在docfx中把元数据以yaml的形式保存,在metadata阶段会序列化数据到yaml文件中,在build阶段又需要从yaml文件反序列化出来.在使用过程中,意外发现yamldotnet在处理大量强类型数据时性能奇差,将yaml反序列化为弱类型后,再序列化为json,再从json反序列化为强类型,这样看起来超级折腾的3步走竟然比yaml直接反序列化为强类型的性能足足提高了3倍...无奈之下,我们开始尝试自己写个序列化器,于是就有了Microsoft.DocAsCode.YamlSerializ…

docfx开源啦

废话不多说了,直接上地址: 源代码: https://github.com/dotnet/docfx 文档: http://dotnet.github.io/docfx/ clone git clone https://github.com/dotnet/docfx.git build准备: install IDE vs2015 / 或者装一堆编译要用的东西,不过我没兴趣研究这个... install nodejs dnvm install 1.0.0-rc1-final build IDE下b…

docfx预热中

奋战了几个月,docfx终于有些像样了. 预览文档: http://aspnet.github.io/docfx/ 源代码正在准备开源中 Nuget包很快会发布 FAQ: Q: docfx是什么? A: docfx是一个api文档编译软件,它能根据c#/vb源代码生成对应的文档元数据并生成文档(目前提供html),并支持普通md文件. Q: docfx的输入和输出是什么? A: docfx metadata需要源代码来生成文档元数据,docfx build使用文档元数据+普通md文件生成文档(h…

DocFX

微软开源全新的文档生成工具DocFX 微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create c…

docfx（二）

1. 初始化一个docfx项目 1.创建一个文件夹D:\docfx_walkthrough 2.运行cmd 到该文件下执行命令D:\docfx_walkthrough 3.输入命令 docfx init -q (执行后会生成一个docfx_project的文件夹) 2. 搭建自己的网站运行命令 docfx docfx_project/docfx.json 执行完后会生成一个子文件夹 _site,这就是静态网站的资源地址. 3. 预览资源网站运行命令docfx serve docfx_pro…

[Other]在 Docker 当中搭建 Docfx 站点

一.简介 Docfx 是微软开发的一款开源的文档生成工具,其默认支持 C# 与 VB.Net 这两种项目的文档生成,支持 DotNetCore 项目,并且还可以打包成一个静态的 Web 站点,而且还支持 markdown 文件. 这个站点就是 ImageSharp 的 API 文档,可以去参考一下. 二.安装下载 Docfx 是即开即用的,他基于 .Net Framework 开发,所以我们可以先在 Windows 平台上面生成 API 文档试一下,DocFx 的下载地址为 https://g…

使用 MarkDown & DocFX 升级 Rafy 帮助文档

最近使用 DocFX 对 Rafy 框架的帮助文档进行了升级. SandCastle 之前 Rafy 框架的帮助文档,是使用 SandCastle 来编写的(https://github.com/EWSoftware/SHFB).如下图: 其文档中的每一个文档都是一个 .aml 文件.aml 文件是一种自定义格式的 xml 文件.示例如下: <?xml version="1.0" encoding="utf-8"?> <topic id="…

使用Docfx生成项目文档

使用docfx.console生成本项目的文档使用docfx.console生成其他项目的文档直接使用docfx.exe生成项目文档指定配置文档模板文档地址:http://gitlab.light.fang.com/konggu.Donet/Documents/blob/master/Fang.Docfx/Docfx.MD…

利用 Github Actions 自动更新 docfx 文档

利用 Github Actions 自动更新 docfx 文档 Intro docfx 是微软出品一个 .NET API 文档框架,有一个理念是代码即文档,会根据项目代码自动生成 API 文档,即使没有写任何注释也会生成 API 文档,也有一些默认的主题可以配置,也可以自定义主题配置,详细介绍可以参考官方介绍 https://dotnet.github.io/docfx/ 目前也有很多项目在使用 docfx 来生成文档,比如前段时间介绍过的 Reserver-Proxy 项目,也是看到了 res…