Skip to content
Snippets Groups Projects
Commit 017a0684 authored by Jean c's avatar Jean c
Browse files

some tips on how to write md pages

parent 777eff6c
No related branches found
No related tags found
1 merge request!16start to work on Help page
Pipeline #112926 failed
...@@ -66,6 +66,62 @@ To do so, just fill in the description (1) of what you did, or anything that you ...@@ -66,6 +66,62 @@ To do so, just fill in the description (1) of what you did, or anything that you
![Create MR](/help/Create_MR.png){max-width=750px} ![Create MR](/help/Create_MR.png){max-width=750px}
**Tips to write :**
As a general advice, check an already written file to see how other pages are written.
The files you edit are in markdown, which is pretty basic language but that can let you do many things, such as tables, links and such with a particular syntax.
You can check more about this syntax here : https://docs.gitlab.com/ee/user/markdown.html
To add images, you need to upload the image of the public folder (and possibly to put it in the corresponding folder of the system) and you can specify its path in the markdown file as follows :
`![Alt-text, get prints if image is not found](/path/within/public){max-width=750px}` where `/path/within/public` is the relative path to the `public` folder (the absolute path would be `/content/public/path/within/public`)
In addition to this, there are some specificities to this wiki.
1. First, each system's page has **frontmatter**, which is a piece of code that will be used to populate the table of the list of system. It has the following syntax :
```yaml
---
title: Viperin
tableColumns:
article:
doi: 10.1038/s41586-020-2762-2
abstract: |
<the abstract>
Sensor: Unknown
Activator: Direct
Effector: Nucleotide modifying
PFAM: PF04055, PF13353
Contributor : Florian Tesson, Aude Bernheim
---
```
2. In the relevant abstract section, only the doi is relevant :
```md
::article-doi-list
---
items:
- doi: 10.1038/s41586-020-2762-2
---
::```
3. To display a protein structure, you can call the plugin as follows :
```md
::molstar-pdbe-plugin
---
height: 700
dataUrl: /avs/AVAST_I,AVAST_I__Avs1B,0,V-plddts_80.96481.pdb
---
::```
### 3/ Review a Merge Request ### 3/ Review a Merge Request
You can review other person's merge request by going the [merge request's pages](https://gitlab.pasteur.fr/mdm-lab/wiki/-/merge_requests). You can review other person's merge request by going the [merge request's pages](https://gitlab.pasteur.fr/mdm-lab/wiki/-/merge_requests).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment