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
Copy file name to clipboardExpand all lines: Contributing.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,19 @@
3
3
2. Run `dotnet tool restore` to install required local tools
4
4
3. Run `dotnet build -c Release -t:Build`
5
5
6
+
# How to build documentation:
7
+
The documentation is built using Hugo and automatically deployed to GitHub Pages on every push to the master branch.
8
+
9
+
To build the documentation locally:
10
+
1. Install [Hugo](https://gohugo.io/getting-started/installing/) (version 0.126.3 or later)
11
+
2. Navigate to the `docs` directory: `cd docs`
12
+
3. Initialize the theme submodule: `git submodule update --init --recursive`
13
+
4. Build the site: `hugo --minify`
14
+
5. The generated site will be in the `docs/public` directory
15
+
6. To preview locally: `hugo server` (available at http://localhost:1313/myriad/)
16
+
17
+
The documentation is automatically published to https://moiraesoftware.github.io/myriad/ via GitHub Actions.
18
+
6
19
# How to debug:
7
20
- uncomment line `<!-- <MyriadSdkWaitForDebugger>true</MyriadSdkWaitForDebugger> -->` in test\Myriad.IntegrationPluginTests\Myriad.IntegrationPluginTests.fsproj
8
21
-`dotnet build test\Myriad.IntegrationPluginTests -v n` the test project
0 commit comments