Docfx: macos support

Created on 15 Jan 2019 · 7Comments · Source: dotnet/docfx

Hey folks; after two weeks of hacking on DocFX on macos, it's pretty clear that it's basically untested and barely working on mac. I see that it's supposed to be "cross-platform," but can you tell me, specifically, what the V3 mac plan is?

We'd love to use DocFX, it has a lot of potential for us, but right now, the struggles we're running into trying to work on it via mac are making us think we might just use MonoDoc + GitHub Pages/Jekyll, to handle our API docs and conceptual docs, respectively.

Area-XPlatform stale

Source

bryancostanich

Most helpful comment

docfx in v3 works on mac and is tested. For API docs, MonoDoc is a good alternative because .NET api docs in docfx v3 is likely to be based on MonoDoc

yufeih on 16 Jan 2019

👍2

All 7 comments

docfx in v3 works on mac and is tested. For API docs, MonoDoc is a good alternative because .NET api docs in docfx v3 is likely to be based on MonoDoc

yufeih on 16 Jan 2019

👍2

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week if no further activity occurs.

stale[bot] on 22 Apr 2019

@BrennanConroy I will close this first. You can create another issue for your specific problem met on macos. Thank you.

superyyrrzz on 22 Apr 2019

BrennanConroy on 22 Apr 2019

😄1

@BrennanConroy Close as this is supported. You can open another issue for the bug you met.

One tip is to download mono from mono website, instead from homebrew

superyyrrzz on 23 Apr 2019

... I didn't open this

BrennanConroy on 23 Apr 2019

docfx in v3 works on mac and is tested.

For the record, you can install docfx v3 as a .NET Core global tool by running the following command:

dotnet tool install -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json

You can read more about docfx v3 in the v3 branch.