# Markdown Guide

Let's keep thing straight. You wanna know how to format the text in chat? Let me show you.

### Different Types of Markdown Formatting

Make sure to use these characters on both sides of the text! For example: \ <mark style="color:blue;">\*if you want to italicize your text, you add these asterisks at the front and end.\*</mark>

`*` | italicizes like *this.*\
`"` | Colors and highlights your dialogue inside quotations.\
`` ` ``  | mono font (can be combined with italics). You can ONLY apply italics with the mono font *when* it it is outside the asterisks. A visual example will be shown in a moment.\
`_` | also acts like `*` just another way to do italics.\
`-` | acts as a bullet point.\
`***`, and `___` | are separator lines for text above and below.\
`#` | Use hashtags to create headers. There's three different sizes. `#` <mark style="color:red;">One hashtag is the largest.</mark> `##` <mark style="color:$danger;">Two hashtags is a slightly less bigger one.</mark> `###` <mark style="color:$warning;">Three hashtags is the least big one.</mark>\
`>` | acts like  `*`  but ignores backspaces between paragraphs, and does NOT italicize the text. DO NOT repeat this character at the end of the text, only use one in front of the text if you want to use it. Like this: <mark style="color:blue;">> Just do this, don't repeat the ">" at the end.</mark>\
`&nbsp;` | acts as a giant and fat linebreak, basically.\
`[insert visible text](#- "insert invisible text")` | Essentially, you are able to hide part of your message from the bot. This is more of a visual effect as your *hidden* text will still be visible to the bot.\
`![](Insert Image URL here)`  | This allows you to insert an image into THE FIRST MESSAGE or Creator Memo of the bot. The same creator rules apply in which that the pictures must be appropriate, and if any, have characters that look of-age. Pictures may be explicit NSFW as long as the bot itself is marked as an NSFW profile. Chibis in the Memo are acceptable as long as they are sfw and clearly chibi and not just a child.\
`>>Insert Text Here<<` | These characters will allow you to apply a spoiler bar / hide text. This can be used in any written field on CharSnap (bot guts, creator memos, anywhere you can write). The AI will still read your messages the same even with the spoiler bar over it. The effect of this markdown is entirely visual only. Perhaps you can use it to blur out your OOC commands for more immersion.\
`@[username]:{Words}[id]:{insert user profile ID}` | This essentially "tags" a user by providing a clickable link to their profile, which is great for gifts and collaborations. The 'username' part MUST stay 'username', do not change that!! The part the says 'Words' can be changed to anything, and will be what the link says. The long bit is the user's ID, which you pull from their profile.\
`<CollapsibleName> I am collapsible! Hide me! </CollapsibleName>` | This lets you create a collapsible list (example image will be provided below. You're able to preview and hide text as you wish with the click of a button. Inside the brackets, title your list whatever you want and put your bullet points in between the variables. Like this: <mark style="color:blue;">\<My List!> I titled my list, that's cool! \<My List!></mark>\
`~~Strike you're out.~~` | If you want to cross out your text like this, add double squiggly lines on both sides of your sentence.

`[![whatever text](image link)](external link)` | Image that also works as a link.

And before you ask: You can bold text, but it will **only** work in the Creator Memo, Bot Description, and Bot Personality fields (for viewing).  At least, that is the case on most devices. Otherwise `**` will not work in RP (in-chat) text. Sorry! Otherwise, see the pictures below if you need a visual on how to format the text. Do note that Markdown can be used *both* during in-chat conversations and in character creation.

<figure><img src="/files/6anCU3sSupXD3qgVgfwz" alt="" width="563"><figcaption><p>The layout. Visual example of how to use markdown.</p></figcaption></figure>

<figure><img src="/files/osxsAjPph5V9rUoQVHg9" alt=""><figcaption><p>The result.</p></figcaption></figure>

DO NOTE that mono font characters *cannot* transfer to another line entirely. Symbols are separated. If you need a better grasp on what that looks like, see the picture below. The D from "Don't" got separated from the rest of the text, because mono text reads messages as separate symbols. Hope that makes more sense!

<figure><img src="/files/UOE6QGn0nA1cjTfeMxS9" alt="" width="375"><figcaption><p>Mono font text (2nd line) breaking off at the end.</p></figcaption></figure>

<p align="center">Examples of <code>[insert visible text](#- "insert invisible text")</code> :</p>

<figure><img src="/files/HfBKZktwYxew6jyFJGui" alt="" width="563"><figcaption></figcaption></figure>

<figure><img src="/files/xS5JBPhscBsOZg9MxHqN" alt=""><figcaption></figcaption></figure>

As soon as the message goes through, you are can hover over your sent-message and see the hidden text become visible in a separate box. Pretty cool! If there are any other types of markdown formatting you happen to discover, but you don't see it here on the wiki, let us know on the Discord!

<p align="center">Examples of <code>![](Insert Image URL here)</code></p>

<figure><img src="/files/4KWOr3cDhi5TkRUsPsy6" alt=""><figcaption><p>Example layout of image markdown text.</p></figcaption></figure>

<figure><img src="/files/VPxCG8nnvqVS2XJL0WwS" alt="" width="375"><figcaption><p>Result of image markdown text.</p></figcaption></figure>

<p align="center">Headers, Strikethroughs, Tagging Users, Collapsible List, and Spoiler Markdown</p>

<figure><img src="/files/4FeJSqwFynmSRqPsn0u6" alt="" width="563"><figcaption><p>Example layout of everything in order.</p></figcaption></figure>

<figure><img src="/files/hTDTnZ2ELYfIzaFZACYL" alt="" width="431"><figcaption><p>Results of markdown format from image above.</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://charsnap.gitbook.io/charsnap/tips/markdown-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
