Skip to content

Commit

Permalink
fix: fixed race condition
Browse files Browse the repository at this point in the history
between the docfx menu and the wordpress one
  • Loading branch information
bchhun authored and alextrepa committed Jan 4, 2021
1 parent 226751d commit 86dccb2
Show file tree
Hide file tree
Showing 6 changed files with 116 additions and 60 deletions.
40 changes: 40 additions & 0 deletions doc/README.md
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.
21 changes: 0 additions & 21 deletions doc/docfx.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,4 @@
{
//"metadata": [
// {
// "src": [
// {
// "src": "../src",
// "exclude": [
// "SolutionTemplate/**",
// "SourceGenerators/SourceGeneratorsConsole/**",
// "SourceGenerators/System.Xaml/**",
// "T4Generator/**",
// "ResourceConverter/**"
// ],
// "files": [
// "**.csproj"
// ]
// }
// ],
// "dest": "api",
// "disableGitFeatures": false
// }
//],
"build": {
"content": [
{
Expand Down
5 changes: 4 additions & 1 deletion doc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
"gulp-sourcemaps": "^2.6.4"
},
"description": "nventive gulp automation",
"main": "gulpfile.js"
"main": "gulpfile.js",
"scripts": {
"generate": "docfx docfx.json"
}
}
2 changes: 1 addition & 1 deletion doc/templates/uno/styles/main.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 86dccb2

Please sign in to comment.