This repo is the core of the NFDI4Chem knowledge base.
Create a fork of the repository. Make additions/changes as you required. Create pull-request. Your changes will then be reviewed by editors of this page. In case of any problems, or if you are unable to contribute via github contact helpdesk@nfdi4chem.de.
- Use british english
- headings with: # (primary), ## (secondary), ### (tertiary etc)
- Citations (e.g. for journal articles): only cite the name of the article and doi (if available) and add link to doi - as opposed to a citation standard such as Angewandte, RSC etc. To cite to a footnote which contains a citation, use a superscripted number.
- For references, sources and/or further information/reading, please always use the heading "Sources and further information".
- Use bullet points
- Indicate if a source is written in German (e.g. - German: Article about ...)
Please place your image files in the suitable subfolder for the topic of your article:
/static/img/domains
/static/img/role
/static/img/problems
/static/img/topics
You can then reference to them by leaving out the /static
part of the path. Preferably add images using the Markdown syntax like this:
![FAIR Data](/img/topics/FAIR_data_principles.png)
Using the img
HTML tag will require additional prerequisites and is discouraged unless specifically needed for the page layout.
This website is built using Docusaurus 2, a modern static website generator.
Instead of npm
you can also use yarn
.
npm install
npm start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. Press Ctrl + C
to stop.
npm run build
This command generates static content into the build
directory and can be served using any static contents hosting service.
npm run clear