hMRI-group / hMRI-toolbox-docs

Sources for the hMRI Toolbox website
https://hmri-group.github.io/hMRI-toolbox-docs/
1 stars 0 forks source link

citation of the homepage theme-design #9

Open Barisevrenugur opened 1 year ago

Barisevrenugur commented 1 year ago

(moved from https://github.com/hMRI-group/hMRI-toolbox-docs/issues/8 on request):

at the beginning of the .yml file:

https://github.com/hMRI-group/hMRI-toolbox-docs/blob/main/mkdocs.yml

the following .json file is cited: https://squidfunk.github.io/mkdocs-material/schema.json

however i had a short look at mkdocs and ran into the following page:

https://jamstackthemes.dev/theme/mkdocs-material/

which has the picture of the theme of the home page of the new hmri website:

image

then should we replace the citation in the .yml with the above webpage instead or add it as a further citation to the .yml file? for clarification , i am not saying that the mkdocs is not cited (it is cited as i have included above) but what i am saying is there seems to be another relevant webpage which perhaps needs to be cited as well, since it seems to contain the theme-design of the home page.

halirutan commented 1 year ago

This is not a citation. The line you are referring to in mkdocs.yml is a directive specifically for tools and editors that understand YAML and support the YAML Language Server. The purpose of this line is to specify a JSON Schema that defines the structure and properties allowed in the YAML file, in this case, for configuring the Material theme.

We cite MkDocs and the Material theme in the first paragraph of the README already.