Skip to content
This repository has been archived by the owner on Oct 21, 2024. It is now read-only.

Latest commit

 

History

History
65 lines (44 loc) · 3.11 KB

README.md

File metadata and controls

65 lines (44 loc) · 3.11 KB
Raw

Caution

This repository is archived and not further developed!

Nfdi4Plants.Fornax

This fornax template implements the existing nfdi-web-components for documentation.

Nfdi4Plants.Fornax.Template NuGet downloads Nfdi4Plants.Fornax NuGet downloads

install & usage

See the official @nfdi4plants/web-components docs for fornax support.

dev

  1. Download repo.
  2. Run dotnet tool restore in root directory.

contribute to library

  1. Make changes to library and add unit tests.
  2. Run .\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.)
  3. Run .\build.cmd release. This will:
    • Run tests
    • Build the library
    • Create a nuget packages for both the library and the template and copy the library-.nupkg to the client test folder.
  4. Update nuget reference for library to new version.
    • In client\loaders\_lib.fsx.
    • 👀 It might be necessary to clear nuget cache if the version was not changed for it to update.
  5. Test the new version.
    • if working correctly upload the new version to nuget
  6. Verify template is working correctly:
    • Only if library was updated:
      • Wait until fully published by nuget then update Nfdi4Plants.Fornax in src/Nfdi4Plants.Fornax.Template/content with
        dotnet paket update Nfdi4Plants.Fornax
      • rebuild with package with .\build.cmd release
    • dotnet new --uninstall Nfdi4Plants.Fornax.Template
    • dotnet new --install pkg\Nfdi4Plants.Fornax.Template.X.X.X.nupkg, adjust semver accordingly.
    • Create a new folder somewhere and do dotnet new NFDIdocs inside. Then follow the freshly created README.md.

update web-components

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.

start test client

  1. Run .\build.cmd fornax in root folder.
  2. Open page http://127.0.0.1:8080 in browser.

Update Searchbar

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.