In our continuous efforts to improve data documentation and make it more user-friendly, we're excited to introduce Markdown—a simple and powerful markup language that allows you to tailor your dataset descriptions just the way you like. Whether you're a seasoned data scientist or a beginner, Markdown is here to make your life easier when it comes to formatting and presenting your data.
Why Markdown?
Markdown is a lightweight markup language that has gained immense popularity in various fields, from web development to documentation. Its simplicity and versatility make it an ideal choice for creating clear and well-structured content. Markdown allows you to format plain text with just a few simple symbols, making it accessible to everyone.
Getting Started with Markdown
If you're new to Markdown, don't worry—it's incredibly easy to learn. Let's dive into some of the basic Markdown instructions you can use to enhance your dataset descriptions:
Headers
Headers help organize your content. Use `#` to create headers, with the number of `#` symbols indicating the header level:
Markdown | Rendered Output |
| Heading level 1 |
| Heading level 2 |
| Heading level 3 |
| Heading level 4 |
| Heading level 5 |
| Heading level 6 |
Paragraphs
To create paragraphs, use a blank line to separate one or more lines of text.
Markdown | Rendered Output |
| I really like using Markdown. I think I'll use it to format all of my documents from now on. |
Links
To create a link, enclose the link text in brackets (e.g., [GeoNadir]) and then follow it immediately with the URL in parentheses (e.g., (https://data.geonadir.com)).
My favorite place to upload drone data is [GeoNadir](https://data.geonadir.com).
The rendered output looks like this:
My favorite place to upload drone data is GeoNadir.
URLs and Email Addresses
To quickly turn a URL or email address into a link, enclose it in angle brackets.
<https://www.geonadir.com> <[email protected]>
The rendered output looks like this:
Emphasis
Bold
To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.
Markdown | Rendered Output |
| I just love bold text. |
| I just love bold text. |
| Loveisbold |
Italic
To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.
Markdown | Rendered Output |
| Italicized text is the cat’s meow. |
| Italicized text is the cat’s meow. |
| Acatmeow |
Bold and Italic
To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.
Markdown | Rendered Output |
| This text is really important. |
| This text is really important. |
| This text is really important. |
| This text is really important. |
| This is reallyveryimportant text. |
With Markdown, you have the power to create informative and visually appealing dataset descriptions that are easy for your team to understand and work with. You'll be amazed at how it streamlines the process and enhances the clarity of your dataset descriptions.
If you have any questions or need further assistance with Markdown, don't hesitate to reach out. Happy documenting!