Skip to content

Commit 7414cb8

Browse files
authored
Add instructions on how to install on a M1 Mac (#8014)
* Add instructions on how to install on a M1 Mac * add link to rosseta
1 parent 05b4ec2 commit 7414cb8

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

Documentation/tutorial/docfx_getting_started.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@ For a detailed description about DFM, please refer to [DFM](../spec/docfx_flavor
2525

2626
*Step1.* Install DocFX. Choose from one of the following sources:
2727
* **[Chocolatey](https://chocolatey.org/packages/docfx)**: `choco install docfx -y`.
28-
* **[Homebrew](https://formulae.brew.sh/formula/docfx)** (owned by community): `brew install docfx`.
28+
* **[Homebrew](https://formulae.brew.sh/formula/docfx)** (owned by community):
29+
* Intel chip: `brew install docfx`.
30+
* M1 chip: DocFX doesn't support the new mac M1 chips so you will need to use [Rosetta](https://support.apple.com/en-nz/HT211861) to run it. Follow these steps:
31+
* [Uninstall Homebrew](https://github.com/homebrew/install#uninstall-homebrew)
32+
* Re-install brew with the following command: `arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
33+
* Install docfx: `arch -x86_64 brew install docfx`
34+
* Run docfx: `arch -x86_64 docfx path/to/docfx.json --serve`
2935
* **GitHub**: 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.
3036
* **NuGet**: `nuget install docfx.console`. `docfx.exe` is under folder *docfx.console/tools/*.
3137

0 commit comments

Comments
 (0)