Markdown is a simple formatting language that allows you to add structure and emphasis to your text within Promptitude. By using markdown in your prompt descriptions, you can highlight important information, create organized lists, and make your content more scannable for your team members.
This article will show you where and how to use markdown in Promptitude, even if you've never used it before.
📌 Where Can You Use Markdown in Promptitude?
Currently, you can use markdown formatting in:
Prompt descriptions - The long-form text areas where you provide context about how your prompts work
More locations coming soon...
Using markdown in these areas helps your colleagues better understand your prompts by emphasizing key points and organizing information logically.
✏️ How to Use Markdown
Markdown uses simple symbols to format text. Here's how to use the most common markdown elements:
➔ Headings
To create headings of different sizes, use the hash symbol (#):
# Heading 1 (largest)
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6 (smallest)
The more hash symbols you use, the smaller the heading will be.
➔ Text Formatting
You can easily add emphasis to your text:
For bold text, surround words with double asterisks or underscores:
**bold text**or__bold text__For italic text, use single asterisks or underscores:
*italic text*or_italic text_For bold and italic text, use three asterisks or underscores:
***bold and italic***or___bold and italic___
➔ Lists
Unordered lists use asterisks (*) , plus signs (+), or hyphens (-):
* Item 1
* Item 2
* Nested item
* Nested item
* Item 3
Numbered lists use numbers followed by periods:
1. First item
2. Second item
* Nested item
* Nested item
3. Third item
1. Nested item
2. Nested item
Tip: 💡 To create nested lists within other lists, simply add four spaces before the next symbol - asterisks (*) , plus signs (+), or hyphens (-).
➔ Links
To create a link, place the link text in brackets followed by the URL in parentheses:
[Visit Promptitude](https://promptitude.com)
➔ Blockquotes
To create a blockquote, use the greater-than symbol (>):
> This is a quote from someone important.
🔔Tips for Using Markdown Effectively
Keep it simple: You don't need to use every markdown feature. Start with basic formatting like bold, italics, and lists.
Use headings to create structure: Break up long descriptions with headings to make them more scannable.
Highlight key information: Use bold text to emphasize important points that your team shouldn't miss.
Create lists for steps or options: When describing how to use a prompt, numbered lists work well for sequential steps.
Add links for further context: If you reference external resources or other prompts, use links to make them easily accessible.
By using markdown in your prompt descriptions, you'll make your content more readable and help your team understand how to use your prompts effectively. The small effort of adding formatting pays off with clearer communication and better collaboration.