Markdown in Docstell

The idea with markdown is that it will save you a lot of time when formatting your texts. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, which is then converted to valid HTML.

Instead of getting frustrated about how a lot of common word processors format your text in every way but the one you want, markdown is very predictable and easy to learn.

The markdown feature in Docstell is really simple to use. When a text block is added to a node you can start typing your markdown right away. When leaving the edit area the text is automatically formatted.

Basic formatting

Here are the basic formatting options that are available:

*Italic*Italic
**Bold**Bold
~~Strike through~~Strike through

Lists

– bullet list
– second bullet

  • bullet list
  • second bullet

1. Numbered list
2. Second row

  1. Numbered list
  2. Second row

Tables

| Feature | Version | Sprint | Deployed |
| – | – | – | – |
| tables | 0.9 | v2 | ✔ |
| bookmarks | 0.9 | v2 | ✔ |

Will be rendered as:


Code blocks

You can embed snippets of code in two ways. Inline code is made with single backticks `code block`, that renders as code block. Use triple backticks before and after the code to format a whole section as a code block. This will always render in full width.

“`html
<!DOCTYPE html>
<html>
<head>
<title>Page Title</title>
</head>
<body>
<h1>This is a Heading</h1>
<p>This is a paragraph.</p>
</body>
</html>
“`

This will render as:

Another example with a javascript block:

“`js
var React = require(‘react’);
var Markdown = require(‘react-markdown’);

React.render(
<Markdown source=”# Your markdown here” />,
document.getElementById(‘content’)
);
“`

Will render as:


Blockquotes

Block quotes is made with >, like:
> All computers wait at the same speed
which renders as:


There are more ways of formatting your texts, for example links and checkboxes. See the Docstell help for a full list of markdown syntax.

If you don’t have a Docstell account yet you can signup here to get one.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>