This repository hosts eto.picoe.ca, the public documentation and API reference for Eto.Forms. The site now runs on Hugo, so you only need one binary to preview or build it.
Install the extended Hugo binary (for example with brew install hugo on macOS). Building the API reference also needs the .NET 8 SDK (or newer) and Node 18 (or newer).
hugo server --disableFastRenderThe server prints a local URL (usually http://localhost:1313). Changes inside the content/, layouts/, assets/, or static/ folders hot-reload automatically.
hugo server doesn't include the API reference. To preview it, run ./build.sh and serve public/, or run dotnet run --project owl/owl -- serve eto/src/Eto/Eto.csproj on its own.
./build.shThis builds the site with Hugo, then the API reference with Owl into public/api, using Eto from the eto submodule and Owl from the owl submodule. It finishes by building the header's search index with Pagefind (settings in pagefind.yml), so search only works in a full build. Deploy the contents of public/. Set OWL_DIR to another Owl checkout to use that instead.
| Path | Purpose |
|---|---|
content/docs |
Markdown source for the guides, tutorials, and contributing docs. _index.md files describe section landing pages. |
eto |
Eto submodule, checked out at the release the API reference documents. |
owl |
Owl submodule, which builds the API reference. |
content/owl-*.md |
The site header and footer as bare snippets, which build.sh passes to Owl for the API pages. |
layouts/ |
Hugo templates (base layout, navigation, sidebar, etc.). |
assets/css/main.css |
Global styles compiled and fingerprinted by Hugo Pipes. |
assets/css/chrome.css |
Header and footer styles, shared with the API pages. |
static/ |
Images and other assets copied as-is to the final site. |
Check out a different Eto release in the submodule (git -C eto checkout 2.10.3), commit the submodule change, and run ./build.sh.
- Use front matter
weightvalues on_index.mdfiles to order sections in the docs sidebar. - Hugo automatically adds every page under
content/docsto the section sidebar, so keep file names and titles descriptive.