You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 20, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-13Lines changed: 5 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,6 @@ DocFX requires the .NET Framework on Windows or Mono for Linux/macOS.
93
93
```
94
94
docfx --serve
95
95
```
96
-
97
96
* In a browser, navigate to `http://localhost:8080`.
98
97
99
98
### Mono instructions
@@ -103,22 +102,15 @@ DocFX requires the .NET Framework on Windows or Mono for Linux/macOS.
103
102
```
104
103
brew install mono
105
104
```
106
-
107
105
* 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.
110
108
111
109
```
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'
119
112
```
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`.
0 commit comments