docfx (一)

什么是docFX?

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

特性

  • 和你的代码紧密集成。你可以在文档中点击 "View Source" 链接导航到github上对应的源代码(你的代码必须发布到 GitHub )。
  • 跨平台的支持。拥有Windows平台以及.NET Core 的跨平台 exe程序。
  • 和Visual Studio集成. 你可以在Visual Studio 中无缝使用 DocFX 。
  • Markdown 扩展。我们推荐DocFX Flavored Markdown(DFM) 格式来编写文档。 DFM 100% 兼容 GitHub Flavored Markdown(GFM) 并且添加了一些有用的扩展,例如 file inclusion( 文件包含), code snippet( 代码片段), cross reference( 交叉引用), 以及 yaml header。

安装docFX

DocFX ships as a chocolatey package. Install docfx through Chocolatey by calling cinst docfx -y.

翻译一下: DocFX 被打包成 chocolatey 包.可以通过 Chocolatey 调用命令 cinst docfx -y 来安装。(这种安装方法俺不会,说的太模糊)。
官网还有一种方法

you can download and unzip docfx.zip from https://github.com/dotnet/docfx/releases, extract it to a local folder, and add it to PATH so you can run it anywhere.

这个方法还行吧,我就用的这个但是我去这个网址下载这个文件下了好几次才成功,也不知道为啥,最后我越狱下载就成功了。

下载成功就解压呗,然后运行 docfx.exe文件,立马弹出一个命令窗口,然后就立马消失。靠我试了好几遍 都是这个样的,有没有搞错,浪费了我不少时间。

最后我决定把这个程序加载到 环境变量中去,cmd运行 ,ok了 ,安装成功。

时间: 2024-08-29 09:28:01

docfx (一)的相关文章

DocFX

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

docfx组件介绍--MarkdownLite

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

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

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

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

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

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

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

https://blog.csdn.net/lindexi_gd/article/details/78661304 c#(166)  版权声明:http://blog.csdn.net/lindexi_gd 本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/lindexi_gd/article/details/78661304 目录(?)[+] 开发中,有一句话叫 最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档.那么世界上文档写最 la 好 ji 的就

NET Core

[.net 面向对象程序设计深入](8)认识.NET Core  1,概述          .NET 经历14年,在Windows平台上的表现已经相当优秀,但是"跨平台.开源"却是其痛点,从16年开始.NET Core的出现将迎来.NET的真正意义上的跨平台和开源序幕.     .NET Core是一个开源通用的开发框架,支持跨平台,即支持在Window,macOS,Linux等系统上的开发和部署,并且可以在硬件设备,云服务,和嵌入式/物联网方案中进行使用.     .NET Cor

.NET Core 全新认识(转载)

.NET Core 全新认识 cnblogs.com/yubinfeng/p/6626694.html 一.概述      .NET 经历14年,在Windows平台上的表现已经相当优秀,但是"跨平台.开源"却是其痛点,从16年开始.NET Core的出现将迎来.NET的真正意义上的跨平台和开源序幕. .NET Core是一个开源通用的开发框架,支持跨平台,即支持在Window,macOS,Linux等系统上的开发和部署,并且可以在硬件设备,云服务,和嵌入式/物联网方案中进行使用. .