Converting GitHub-flavored Markdown to OctoberCMS

by László L. Lieszkovszky

Working on publishing my firs plugin on the OctoberCMS marketplace and unfortunately once again I find myself in dire need of comprehensive docs.

Let me mark down for myself and you my fair reader what I've stumbled upon.

In GitHub, you get anchors created automatically for each heading. Not so in October. Instead, you have to explicitly name each anchor as so:

# My Heading {#my-heading-id}

And then you can link back to it:

[Link to My Heading](#my-heading-id)

Code Blocks

In GitHub, you can specify what language a code block is as follows:

```html
<some html>
```

But if you do so with October, you'll get everything double-encoded:

&lt;some html&gt

The solution? OMIT the language code:

```
<some html>
```

Blockquotes

Here, GitHub is behind. There, if you want a blockquote, you have to do some fancy html like:

<blockquote>
<p><strong>Note</strong>: You must have a <code>{% styles %}</code> and <code>{% scripts %}</code> tag in your page header/footer so that the plugin can inject the required assets.</p>
</blockquote>

And of course you can't mix HTML and markdown so once you open that <blockquote> you have to keep writing HTML.

Not in October!

There you can just write:

> Note: You must have a `{% styles %}` and `{% scripts %}` tag in your layout header/footer so that the plugin can inject the required assets.

Double-Quotes in Inline Code Blocks

Apparently October can't handle them, so they end up looking like this: theme_panel_position: &quot;bottom&quot;

I haven't found a workaround so far, so I'm just using single quotes for now...

Please let me know in the comments if I've missed something!