-
Notifications
You must be signed in to change notification settings - Fork 700
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
between the docfx menu and the wordpress one
- Loading branch information
Showing
6 changed files
with
116 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Documentation Uno | ||
|
||
This folder contains source code for the generation of uno's documentation | ||
|
||
# Running a local environement | ||
|
||
## Install dependencies | ||
|
||
Download and install docfx on your computer. | ||
|
||
### MacOS | ||
|
||
``` | ||
brew install docfx | ||
``` | ||
|
||
### Windows | ||
|
||
``` | ||
choco install docfx | ||
``` | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
## To see your changes run | ||
``` | ||
gulp | ||
``` | ||
|
||
## and to build the documentation use | ||
|
||
``` | ||
npm run generate | ||
``` | ||
|
||
The local environement is usually located on port `3000` unless another process is already using it. | ||
|
||
You have to remove the `docs` fragment from the wordpress menu to reach your local documentation server. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.