Skip to content

CaSe-group/case-group.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

151 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

webpage

Modifying a page

  • simply go to the coresponding .md file edit it and commit
  • done

Adding publications to the profile

  • get a bibtex file - see below (from google scholar)
  • manually add the doi field (without the https://doi.org/)
  • manually add a PMID if its available (will create a pubmed link)
  • got to docs/publications/data/publications.bib and copy this bib text into the doc
@article{reuken2021severe,
  title={Severe clinical relapse in an immunocompromised host with persistent SARS-CoV-2 infection},
  author={Reuken, Philipp A and Stallmach, Andreas and Pletz, Mathias W and Brandt, Christian and Andreas, Nico and Hahnfeld, Sabine and Löffler, Bettina and Baumgart, Sabine and Kamradt, Thomas and Bauer, Michael},
  journal={Leukemia},
  volume={35},
  number={3},
  pages={920--923},
  year={2021},
  publisher={Nature Publishing Group},
  doi={10.1038/s41375-021-01175-8},
  PMID={33608636},
  PMCID={PMC7893131}
}

Adding a page or changing structure

mkdocs needs a .md file in docs/ and the correct "link" in mkdocs.yml

example:

  • e.g. i want to add foo.md to the "bar" kategory on the webpage
  1. create the md file
    • touch docs/bar/foo.md
    • edit foo.md using markdown syntax
  2. "link" the foo.md
    • nano mkdocs.yml
    • go to # Navigation
      • this represents the "kategories" written as plain text
      • you should understand this based on the structure ;) buut:
    • add this:
- whateveryouwant: 
        - whateveryouwant2: bar/foo.md

Change webpage appearance and style

  • Detailed style tutorial can be found here
  • a docker will render the local webpage so you can check what is happening
  • to do a "dry run and live test" run the following commands:
git clone https://github.com/CaSe-group/case-group.github.io.git
# or if repo exists
git pull

# within the directory of the git do
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
  • open the local webpage in your browser via http://0.0.0.0:8000/
  • now you can check the changes

Releases

No releases published

Packages

No packages published

Contributors 5