> For the complete documentation index, see [llms.txt](https://hntech.gitbook.io/blueconda-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hntech.gitbook.io/blueconda-documentation/your-first-project-beginners/using-mdeditor.md).

# Using MDEditor

## What is Documentation?

Simply put, documentation is exactly what you're reading right now! It's a document used to explain a program and what it can do. Its most important if you've just made a new app and want to teach people how to use it.

Not all documentation is as complex as this Blueconda documentation. That's because not all programs are so big. One example of a simple documentation is a README. This is a file that normally goes alongside code to explain what it does, how to use, any dependencies, etc.

## What is MDEditor?

MDEditor stands for **Markdown Editor**. Markdown is a simple language used to create some simple documentation. Most README files are also made in Markdown because it is mostly plain text but allows some customization. A markdown file is stored with the extension .md.

## Using MDEditor

Launch MDEditor by clicking the markdown button:

<figure><img src="/files/7MKdPtkOtMjWxVYXQFPX" alt="" width="125"><figcaption><p>Notice the MD?</p></figcaption></figure>

This is what Markdown Editor looks like:

<figure><img src="/files/pddCF64KRaQsS1FwsgEL" alt="" width="375"><figcaption><p>Looks minimalist and sleek.</p></figcaption></figure>

Let's go through some common markdown tags:<br>

<pre class="language-markdown"><code class="lang-markdown"><strong>## Heading
</strong><strong>**Bold**
</strong>*Italic*
`Code`
[Link](google.com)

</code></pre>

* Heading: Using one hash (#) means the biggest Heading (h1). Using two hashes means a smaller heading (## h2). You can have headings in six sizes, ranging from one hash to six. They're also named accordingly (h1 to h6).
* Bold: Making text bold **like this** makes it stand out an adds emphasis.
* Italic: Italic text *like this* is used for terms, vocab, or a quote to make it stand out.
* Code: Code bits `like this` show that the text is a code snippet.
* Links: Written in the format \[Display Text]\(<https://website.com>). Used to simplify links by embedding clickable links.

After writing your file, you can go into `options > save as` and save as a Markdown file.&#x20;

{% hint style="info" %}
READMEs are common if you are publishing your code to somewhere like GitHub. They typically include info about the name of the author, usage of the code, its license, etc.
{% endhint %}

If you want to see how to implement a README, check out this link here: (This is an interactive example)

{% embed url="<https://www.makeareadme.com/#template-1>" %}
