Skip to content
This repository was archived by the owner on Apr 20, 2019. It is now read-only.

Commit dcedf48

Browse files
authored
Contributing DocFX Mono updates (#319)
1 parent 7f7f202 commit dcedf48

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ DocFX requires the .NET Framework on Windows or Mono for Linux/macOS.
9393
```
9494
docfx --serve
9595
```
96-
9796
* In a browser, navigate to `http://localhost:8080`.
9897

9998
### Mono instructions
@@ -103,22 +102,15 @@ DocFX requires the .NET Framework on Windows or Mono for Linux/macOS.
103102
```
104103
brew install mono
105104
```
106-
107105
* Download the [latest version of DocFX](https://github.com/dotnet/docfx/releases).
108-
* Extract the archive to */bin/docfx*.
109-
* Create an alias for **docfx**:
106+
* Extract the archive to *$HOME/bin/docfx*.
107+
* Create a pair of aliases for **docfx** in a bash shell. The first alias is used to build the documentation. The second alias is used to build and serve the documentation.
110108

111109
```
112-
function docfx {
113-
mono $HOME/bin/docfx/docfx.exe
114-
}
115-
116-
function docfx-serve {
117-
mono $HOME/bin/docfx/docfx.exe serve _site
118-
}
110+
alias docfx='mono $HOME/bin/docfx/docfx.exe'
111+
alias docfx-serve='mono $HOME/bin/docfx/docfx.exe --serve'
119112
```
120-
121-
* Run `docfx` from the root of the repo to build the site, and `docfx-serve` to view the site at `http://localhost:8080`.
113+
* Execute `docfx` from the root of the repo to build the site. Execute `docfx-serve` to view the site at `http://localhost:8080`.
122114

123115
## Voice and tone
124116

0 commit comments

Comments
 (0)