This is the repo to manage all the public documentation.
How to manage versions correct? intelops#29 (comment)
Manage docs site version name (label) display in url and also in dropdown of versions? intelops#29
Example template for some markdown rendering on this docs site - https://demo.gethugothemes.com/godocs/site/style-1/basic-startup/elements/
Here is example of hedings. You can use this heading by following markdownify rules. For example: use # for heading 1 and use ###### for heading 6.
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. Scratch this.
I'm an inline-style link with title
I'm a relative reference to a repository file
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. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
Lorem ipsum dolor sit amet consectetur adipisicing elit. Quam nihil enim maxime corporis cumque totam aliquid nam sint inventore optio modi neque laborum officiis necessitatibus, facilis placeat pariatur! Voluptatem, sed harum pariatur adipisci voluptates voluptatum cumque, porro sint minima similique magni perferendis fuga! Optio vel ipsum excepturi tempore reiciendis id quidem? Vel in, doloribus debitis nesciunt fugit sequi magnam accusantium modi neque quis, vitae velit, pariatur harum autem a! Velit impedit atque maiores animi possimus asperiores natus repellendus excepturi sint architecto eligendi non, omnis nihil. Facilis, doloremque illum. Fugit optio laborum minus debitis natus illo perspiciatis corporis voluptatum rerum laboriosam.
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
- List item
{{< notice "note" >}} This is a simple note. {{< /notice >}}
{{< notice "tip" >}} This is a simple tip. {{< /notice >}}
{{< notice "info" >}} This is a simple info. {{< /notice >}}
{{< notice "warning" >}} This is a simple warning. {{< /notice >}}
{{< tabs "my-tab" >}}
{{< tab "first" >}} This is first tab {{< /tab >}}
{{< tab "second" >}} this is second tab {{< /tab >}}
{{< tab "third" >}} this is third tab {{< /tab >}}
{{</ tabs >}}
{{< collapse "This is an Collapse" >}}
- Lorem ipsum dolor sit amet consectetur adipisicing elit.
- Lorem ipsum dolor sit amet consectetur adipisicing elit.
- Lorem ipsum dolor sit amet consectetur adipisicing elit. {{< /collapse >}}
{{< collapse "This is a dummy description text" >}} This is the start of dummy description text. You can change it whenever you want. It is used to test the responsiveness of the site. It is not used in the actual site. {{< /collapse >}}
Inline code has back-ticks around it.
var s = "JavaScript syntax highlighting";
alert(s);s = "Python syntax highlighting"
print sNo language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.This is a blockquote example.
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
Colons can be used to align columns.
| Tables | Are | Cool |
|---|---|---|
| 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.
| Markdown | Less | Pretty |
|---|---|---|
| Still | renders |
nicely |
| 1 | 2 | 3 |
{{< image src="img-1.jpg" alt="image" zoomable="true" >}}
{{< youtube 8cdO5mJnPws >}}
To write content in a fancy style like docbox template layout see the sample in docbox-layouts folder in 1.0.1 version.