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
1. Pull in the latest files from the submodules according to the commit that the submodules point to:
29
29
``` console
30
30
git submodule update --recursive --init
31
31
```
32
32
In particular, the source code is available in this repo as a submodule. This will update the source code to the latest commit on main.
33
-
1. Configure the docfx version and restore docfx companion tools such as [DocLinkChecker](https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/DocLinkChecker).
1. To make the `docfx` command available after restoring the config file from the previous step, run:
33
+
1. Configure the docfx version and restore docfx companion tools such as [DocLinkChecker](https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/DocLinkChecker). You need to be in the same root folder where you cloned the repository for this to work. Run:
38
34
``` console
39
35
dotnet tool restore
40
36
```
37
+
to make the `docfx` command available.
38
+
41
39
If the above command yields the following error:
42
40
``` console
43
41
It was not possible to find any installed .NET Core SDKs
44
42
```
45
43
even after installing .NET as described previously in the readme, refer to [this comment](https://github.com/dotnet/core/issues/6095#issuecomment-809006602) for a potential fix. If you follow the instructions described in the comment, make sure you proceed in a terminal or command prompt opened after changing the environment variables.
46
-
1. Set up a local Bonsai environment for automatically exporting SVGs, run:
44
+
1. Set up a local Bonsai environment for automatically exporting SVGs, run Setup.ps1 in PowerShell (or, if not using PowerShell, run Setup.Cmd):
47
45
``` console
48
46
./.bonsai/Setup.ps1
49
-
```
47
+
```
50
48
If the above command yields the following error:
51
49
``` console
52
50
./Setup.ps1 : File C:\Users\User\...\bonsai-onix1-docs\Setup.ps1 cannot be loaded because running scripts is
@@ -66,6 +64,8 @@ To build the docs and serve locally, run in PowerShell:
66
64
./build.ps1 --serve
67
65
```
68
66
67
+
If this doesn't run, see comment in section above.
68
+
69
69
If SVGs are already exported and do not need to be updated, they don't need to be re-exported. In that case, to build the docs and serve locally more quickly, run:
70
70
71
71
```console
@@ -96,7 +96,7 @@ The above set of commands can also be run using the `docfx-utils.ps1` Powershell
96
96
To run the next command, install [Lychee](https://github.com/lycheeverse/lychee?tab=readme-ov-file) by following [these instructions](https://github.com/lycheeverse/lychee?tab=readme-ov-file#installation). If you are use Windows and download a Lychee executable, amend the below command according to the location and version of your Lychee executable, and run it.
0 commit comments