This fornax template implements the existing nfdi-web-components for documentation.
See the official @nfdi4plants/web-components docs for fornax support.
dotnet tool restore
in root directory..\build.cmd releasenotes semver:xxx
, where xxx
can be minor, major or patch. (This will also update the version in package.json
inside the template project.).\build.cmd release
. This will:
client\loaders\_lib.fsx
.dotnet paket update Nfdi4Plants.Fornax
.\build.cmd release
dotnet new --uninstall Nfdi4Plants.Fornax.Template
dotnet new --install pkg\Nfdi4Plants.Fornax.Template.X.X.X.nupkg
, adjust semver accordingly.dotnet new NFDIdocs
inside. Then follow the freshly created README.md.Check out the installation docs on nfdi4plants/web-components. For fornax you will need to bundle the web-components with rollup. See the respective section for more information.
.\build.cmd fornax
in root folder.We use Pagefinder as basis for static website search.
It generates the client/_public/_pagefind
folder, containing css and js to power the searchbar.
If the searchbar is not visible (should be above sidebar) you need to rerun pagefind.
Run: npx -y pagefind --source .\client\_public\
This will create the necessary files. But at the moment will not correctly work when Using the testclient. It will show the ui part but will not function.
To test the searchfunction you can use: npx -y pagefind --source .\client\_public\ --serve
.