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').
You can write content using GitHub-flavored Markdown syntax when styling markdown based Docusaurus sites.
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes.
- First ordered list item
- Another item
- Unordered sub-list.
- Actual numbers don't matter, just that it's a number
- Ordered sub-list
- And another item.
- Unordered list can use asterisks
- Or minuses
- Or pluses
Or leave it empty and use the link text itself.
Some text to show that the reference links can follow later.
Here's our logo (hover to see the title text):
Images from any folder can be used by providing path to file. Path should be relative to markdown file.
Colons can be used to align columns.
|col 3 is||right-aligned||\$1600|
|col 2 is||centered||\$12|
|zebra stripes||are 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.
Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
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.
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
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