Skip to main content

Using Markdown in Project Descriptions

Written by Wojtek Jodel

In Magma, you can now add descriptions to your projects to provide context and information for other users.

The project description form uses Markdown syntax, a lightweight markup language that allows for easy formatting of text. Here's how you can use Markdown to create rich, informative project descriptions:

Headers

You can create headers by using one or more hashtags (#) at the beginning of a line. The number of hashtags determines the level of the header.

Please make sure to add space character (" ") between hash characters and text.

For example:

# This is a level 1 header
## This is a level 2 header
### This is a level 3 header

Emphasize

To italicize text, use a single asterisk (*) or a single underscore (_) before and after the text you want to emphasize. For example:

This is *emphasized* text.
This is _also_ emphasized text.

You can also make text bold by using two asterisks (**) or two underscores (__) before and after the text you want to emphasize. For example:

This is **bold** text.
This is __bold__ text.

Lists

You can create unordered lists by using asterisks (*) or dashes (-) followed by a space. You can create ordered lists by using numbers followed by a period (.) and a space. For example:

* Item 1
* Item 2
* Item 3

1. First item
2. Second item
3. Third item

Links

You can create links by using square brackets [] to enclose the link text, and parentheses () to enclose the URL. For example:

This is a [link](http://www.example.com).

Images

You can add images by using an exclamation mark (!), followed by square brackets [] to enclose the alt text, and parentheses () to enclose the image URL. For example:

![alt text](http://www.example.com/image.jpg)

That's it! With these basic Markdown syntax rules, you can now create informative and well-formatted project descriptions for your Magma projects.

Did this answer your question?