Skip to content

Commit c1782bb

Browse files
Copilot7sharp9
andcommitted
Add documentation build instructions to Contributing.md
Co-authored-by: 7sharp9 <[email protected]>
1 parent e5d8aba commit c1782bb

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@
33
2. Run `dotnet tool restore` to install required local tools
44
3. Run `dotnet build -c Release -t:Build`
55

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+
619
# How to debug:
720
- uncomment line `<!-- <MyriadSdkWaitForDebugger>true</MyriadSdkWaitForDebugger> -->` in test\Myriad.IntegrationPluginTests\Myriad.IntegrationPluginTests.fsproj
821
- `dotnet build test\Myriad.IntegrationPluginTests -v n` the test project

0 commit comments

Comments
 (0)