Instruction Manual

Welcome to the Lambert iGEM wiki editor. This editor integrates with iGEM Gitlab and allows you to directly edit the content of writeups without worrying about any code. Each time you press save, your edits will save on GitLab on your behalf and the wiki will be updated.

Editing the wiki

The contents of the wiki are written using MDX (Markdown X). Markdown is an easy to use mark up format used to add basic formatting to plain text. MDX is built on top of Markdown X and allows for the use of custom components and layouts beyond the basic linear flow.

Page Layout

On the top of each markdown file, you will find a section that looks some what like this

--- 
layout: ../layouts/PageLayout.astro 
title: Attributions
header: website.com/image.jpg
---
import Wip from "../components/md_components/Wip";

Do NOT edit anything in this section. The lines between the --- are properties that change the layout, title, and header of the page. In most cases you do not need to edit anything. Import statements are helpers for the components that we will use later.

After this section comes the page content that is displayed. Markdown is very easy to use and read. You can directly start typing, or more probably, copy pasting your writeups like any other text editor.

Basic Markdown Syntax

Refer to this page for a cheatsheet on basic markdown syntax.

Special cases

Images

Use instructions from iGEM HQ to upload pictures and videos through the upload portal and put the link of the image in an Image tag like below. You can also customize the width of the image by setting size to "sm", "md", "lg", "xl", or "2xl". It's "lg" by default.

<Image src='https://uploads.igem.org/wiki/2021/team/igem-lambert/attributions/igem-logo.png' size='lg' caption='Figure 1. blah blah' />

References

We made a special References component to properlly format everything with hanging indents. Use it like so:

<Reference> Your reference text </Reference>

Links to other pages

use special markdown links to link to other pages. You may ONLY link to other pages in our wiki. Links to outside websites will disqualify us and we will be flagged as cheating. Link to other pages like so where anything in the square brackets are the text that is displayed and inside the parentheses is the link:

[see Software](https://2023.igem.wiki/lambert-ga/software/)

Custom Components

We built a collection of custom components that you can use out of the box. To use a custom component, just copy the snippet of the component you want to use and change the attributes. If you need a layout option that we do not provide or a custom custom component, just let anyone on the wiki committee know.

more components coming soon