Skip to main content

Appendix: Adding content to this documentation site

Read the guidance below before contributing to our documentation page. It includes information about formatting text in Docusaurus, the platform this website runs on.

Content Guidelines​

Link to someone else's documentation when you can. If you want to give information that isn't specific to AssemblyLine, try to find documentation that is being maintained by someone else. If it's something about Trello, try to find the Trello documentation. For Github, try to find Github documentation. Same for docassemble. Their projects will do a much better job keeping up to date than you can. Only make new documentation when the existing documentation doesn't exist or is not enough.

Avoid resource link or index-type pages. This site will have a search bar. Because of that, collections of links or pages that index other pages or content will end up appearing in the search findings even though they will not take the user to the meat of what they're looking for. Agolia's docsearch will power our searches. See Agolia's passage on the topic and the more extensive article they link to (search for 'Relevant content only').

Markdown Syntax​

You can write content using GitHub-flavored Markdown syntax when styling markdown based Docusaurus sites.


H1 - Create the best documentation

H2 - Create the best documentation​

H3 - Create the best documentation​

H4 - Create the best documentation​

H5 - Create the best documentation​
H6 - Create the best documentation​


Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strike through text uses two tildes. Scratch this.


  1. First ordered list item
  2. Another item
    • Unordered sub-list.
  3. Actual numbers don't matter, just that it's a number
    1. Ordered sub-list
  4. And another item.
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. or and sometimes (but not on GitHub, for example).

Some text to show that the reference links can follow later.


Here's our logo (hover to see the title text):

Inline-style: alt text

Reference-style: alt text

Images from any folder can be used by providing path to file. Path should be relative to markdown file.



var s = 'JavaScript syntax highlighting';
s = "Python syntax highlighting"
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
function highlightMe() {
console.log('This line can be highlighted!');


Colons can be used to align columns.

col 3 isright-aligned\$1600
col 2 iscentered\$12
zebra stripesare neat\$1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.


Block quotes​

Block quotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Inline HTML​

Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.

Line Breaks​

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.



This is a note


This is a tip


This is important


This is a caution


This is a warning