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

Commit

Permalink
Update README for pagefinder 📚
Browse files Browse the repository at this point in the history
  • Loading branch information
Freymaurer committed May 16, 2023
1 parent ddc3754 commit 800847e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,19 @@ Check out the installation docs on [nfdi4plants/web-components](https://github.c

1. Run `.\build.cmd fornax` in root folder.
2. Open page [http://127.0.0.1:8080](http://127.0.0.1:8080) in browser.

## Update Searchbar

We use [Pagefinder](https://pagefind.app/docs/) 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](##start-test-client).
It will show the ui part but will not function.

To test the searchfunction you can use: `npx -y pagefind --source .\client\_public\ --serve`.


14 changes: 14 additions & 0 deletions src/Nfdi4Plants.Fornax.Template/content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ _Might need to install rollup globally before._

`dotnet paket update Nfdi4Plants.Fornax`

## Update Searchbar

We use [Pagefinder](https://pagefind.app/docs/) as basis for static website search.
It generates the `src/_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**: `npm run index`

This will create the necessary files. But *at the moment* will not correctly work when [Using the testclient](##start-test-client).
It will show the ui part but will not function.

To test the searchfunction you can use: `npm run indexserve`.

## Schedule automatic updates for gh-pages

See [here](https://nfdi4plants.github.io/web-components-docs/docs/ScheduledUpdates.html).

0 comments on commit 800847e

Please sign in to comment.