Skip to content

Commit 86dccb2

Browse files
bchhunalextrepa
bchhun
authored andcommitted
fix: fixed race condition
between the docfx menu and the wordpress one
1 parent 226751d commit 86dccb2

File tree

6 files changed

+116
-60
lines changed

6 files changed

+116
-60
lines changed

doc/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Documentation Uno
2+
3+
This folder contains source code for the generation of uno's documentation
4+
5+
# Running a local environement
6+
7+
## Install dependencies
8+
9+
Download and install docfx on your computer.
10+
11+
### MacOS
12+
13+
```
14+
brew install docfx
15+
```
16+
17+
### Windows
18+
19+
```
20+
choco install docfx
21+
```
22+
23+
```
24+
npm install
25+
```
26+
27+
## To see your changes run
28+
```
29+
gulp
30+
```
31+
32+
## and to build the documentation use
33+
34+
```
35+
npm run generate
36+
```
37+
38+
The local environement is usually located on port `3000` unless another process is already using it.
39+
40+
You have to remove the `docs` fragment from the wordpress menu to reach your local documentation server.

doc/docfx.json

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,4 @@
11
{
2-
//"metadata": [
3-
// {
4-
// "src": [
5-
// {
6-
// "src": "../src",
7-
// "exclude": [
8-
// "SolutionTemplate/**",
9-
// "SourceGenerators/SourceGeneratorsConsole/**",
10-
// "SourceGenerators/System.Xaml/**",
11-
// "T4Generator/**",
12-
// "ResourceConverter/**"
13-
// ],
14-
// "files": [
15-
// "**.csproj"
16-
// ]
17-
// }
18-
// ],
19-
// "dest": "api",
20-
// "disableGitFeatures": false
21-
// }
22-
//],
232
"build": {
243
"content": [
254
{

doc/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,8 @@
1515
"gulp-sourcemaps": "^2.6.4"
1616
},
1717
"description": "nventive gulp automation",
18-
"main": "gulpfile.js"
18+
"main": "gulpfile.js",
19+
"scripts": {
20+
"generate": "docfx docfx.json"
21+
}
1922
}

doc/templates/uno/styles/main.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)