Skip to content

advanced.md

Latest commit

 

History

History
132 lines (88 loc) · 3.33 KB

advanced.md

File metadata and controls

132 lines (88 loc) · 3.33 KB

Advanced stuff

Downloadable files

Please place downloadable files, e.g. document templates, in the assets folder:

/static/assets/file.pdf
/static/assets/template.docx

In order to link the file in your document, use the following Markdown:

[Link text](pathname://../../../assets/file.pdf)

The example assumes that your Markdown file is located on the third filesystem level, e.g. /docs/10_domains/. If not, please adjust the number of ../ pointers accordingly.

Format images

In some cases, the image markdown might be too limited. For that case, we provide a custom <FloatImage /> component.

Important: In MDX files, import the component after the frontmatter section:

---
title: My Page Title
---

import FloatImage from "@site/src/components/commons/FloatImage";

# Page content starts here

<FloatImage 
  url="/img/example.png" 
  alt="Example image"
  width="300px"
/>

You can also make the image clickable by adding a link prop:

<FloatImage 
  url="/img/logo.png" 
  alt="NFDI4Chem logo"
  width="200px"
  link="https://nfdi4chem.de"
/>

For more details, refer to the Custom Components documentation.

Dynamic tables

All or individual entries

The use of dynamic table data is possible. The first example is the table with the analytical methods, used for example in the article Synthetic Organic/Inorganic Chemistry.

The table data is stored in this file: /static/assets/methods.json

In your page, you have to include the table generation script with:

import MethodsTable from '@site/src/components/methods.js';

The table is then generated with <MethodsTable defaultProfile={ "argument" } />. You can either use all as argument or choose the name of the required methods set (currenty available: synthetic, magres, physical, pharma).

Define a set of methods

If required, you can also define your own set of methods in /static/assets/profiles.json (use the shortname properties of the methods):

{
    "name": "magres",
    "longname": "Magnetic Resonance",
    "methods": [ "nmr","epr" ]
},

Like above, include the profile table generation script with:

import MethodsTable from '@site/src/components/methods.js';

You can then generate the table with your set of entries using <MethodsTable defaultProfile={"magres"} />, yielding this table:

Knowledge Base in numbers

Stuff that's interesting for reporting. Use a local BASH terminal for extracting some numbers about the Knowledge Base.

Clone the Knowledge Base to your local environment

git clone https://github.com/NFDI4Chem/knowledge_base
cd knowledge_base

Number of pages

find docs -name "*.mdx" | wc -l

Number of words

find docs -name "*.mdx" | xargs wc -w

Number of commits

git log | grep -c "^commit"

Number of GitHub contributors

wget -q  -O- 'https://api.github.com/repos/nfdi4chem/knowledge_base/contributors?per_page=999&anon=true' | grep "login" | sort | uniq | wc -l

Number of "Anonymous" contributors

wget -q  -O- 'https://api.github.com/repos/nfdi4chem/knowledge_base/contributors?per_page=999&anon=true' | grep "email" | sort | uniq | wc -l