Template for a Doc
note
Copy this markdown file and fill it out for documentation. See the markdown code to see how it all works. For full markdown code and options, see Markdown Features.
Replace the H1 title above with the title for your documentation page. You should only every have one H1 entry used for the title. All other sections should be H2, H3, ...H5.
Sample H2 section
To add an image, save the .png file with a simple name, no spaces in it, in /static/img
. For many images, consider guide or product feature folders. Include alt text and the file location /img/folder-name/
and file name.
![Sumo Logic logo](/img/sumo-square.png)
Instructions
Always use 1.
to start your instructions. You don't need to actually number the list. It will automatically number for you on build.
Click Collections, then Sources tab.
Next step, just write it out.
- Bullet list just tab and use
*
or1.
. - Next bullet.
- Bullet list just tab and use
The numbers continue with content indented above!
Here is an example table:
Item | Description |
---|---|
Dashboard | Info on Dashboards. Markdown works here too. |
Query | More info! |