search

nfdi4plants / web-components

DataPLANT branded web-components for diverse elements. Used in knowledgebase and main pages.
https://nfdi4plants.github.io/web-components-docs/
4 stars 3 forks source link

Allow structuring docs articles in sub-directories. #20

Closed Brilator closed 2 years ago

Brilator commented 2 years ago

To structure content in the knowledge base, let web-components parse .md`s in subdirectories.

I would suggest:

(src/docs)/fundamentals -> articles on RDM and FAIR fundamentals (src/docs)/implementation -> articles on tools and how we implement FAIR RDM in DataPLANT (src/docs)/tutorials -> training materials and smaller tutorials

Brilator commented 2 years ago

@Freymaurer

Freymaurer commented 2 years ago

I will try to do the parsing with an exclusion list. Like "parse all subfolders, except sidebars and ignore all files, named README.md.

Brilator commented 2 years ago

Sounds good. Would also be more flexible in case we need to change.

I added a note to the "how-to" that fornax will try to parse (and fail if yaml missing) any md in the docs (except README.md).

Freymaurer commented 2 years ago

Handled according to https://github.com/nfdi4plants/nfdi4plants.knowledgebase/tree/main/src#markdown-to-html-rendering-rules