Supported Static Site Generators

These docs are created using this setup, so you can always have a look at the source repo if you find something missing.

Docs for version: ^1.0.2

1. dotnet new --install Nfdi4Plants.Fornax.Template, to install the current version of the template.
2. dotnet new NFDIdocs, after navigating to the folder in which you want to initiate the template.
3. dotnet tool restore
4. dotnet paket install
5. Navigate to the src folder (cd src) and start the application with dotnet fornax watch
6. Set up gh-pages.
7. (Optional, recommended) Set up scheduled updates.

To add more documentation, add a markdown file to \src\docs. The file MUST start with a metadata block:

• MUST start and end with --- .
• Keys (layout, author, etc.) are NOT case sensitive.
• Fields MAY be in any order.
• MUST contain layout: docs.
  • This triggers fornax parsing to html.
• MUST contain title: xxxx.
  • Will be added as "# xxxx" to the html.
  • Will be used to name the generated webpage.
• IF duplicates of a field, without duplicate support, exist the first one is used.
• MUST contain date: yyyy-MM-dd.
• MAY contain Author: xxxx.
• MAY contain add toc: false.
  • If true, adds automated table of contents from all found headers in content.
  • Default is true.
• MAY contain add support: false.
  • If true adds DataPlant support component at the bottom.
  • Default is true.
• MAY contain add sidebar: relative/path/to/sidebar.md to add the sidebar element to the page.
• MAY contain any other metadata. The information will be read but will not affect the generated html.

Examples:

Format is date: yyyy-MM-dd.

Examples:

Sidebar files MUST be in ANY subdirectory of \src\docs, which is excempted from docs layout parsing.

useNewSidebar = true decides which type of sidebar is preferred:

• Old Sidebar: false for nfdi-sidebar-element.
• New Sidebar: true for nfdi-sidebar-eleneo.

Sidebar markdown files must start with a metadata block:

• MAY contain any other metadata. The information will be read but will not affect the generated html.

To add a sidebar element use header syntax in combination with links. Any lower level header will be nested to into its higher level header.

This is not the default sidebar anymore

To add a sidebar element to the page, use the codeblock syntax:

```Data Management Plan
# Data Management Plan:/docs/DataManagementPlan.html
## Advantages of a DMP:/docs/DataManagementPlan.html#advantages-of-a-dmp
### Elements of a DMP?:/docs/DataManagementPlan.html#elements-of-a-dmp
# DataPLANT's Data Management Plan Generator:/docs/DataManagementPlan.html#dataplants-data-management-plan-generator
```

• All text after the opening ``` will be parsed to the element title.
• Inner text MUST only contain heading lines.
  • Only headers up to ### are parsed. All header with more depth are parsed to ###.

We use Pagefinder 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.

npm run index

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: npm run indexserve.

Activate with useNewSidebar = true.

Add the following part after the Build step in .github/workflows/deploy.yml.

DataPLANT Support