Documentation source for Cyberduck, Cyberduck CLI & Mountain Duck
Libre file transfer client for macOS and Windows. Command line interface (CLI) for Linux, macOS and Windows.
- Python
- make
pip install sphinx
pip install -r requirements.txt
Build the documentation by running
make html
Output can be found in _build/html
.
Contributions to this documentation are welcome. Please open a pull request.
Add an empty line...
- ...after a heading
- ...before and after an admonition or codeblock
- ...after the admonition class for custom admonitions
- ...after a tab opening and before a tab closing as shown in the Tabs Section
- ...before and after tables
- ...before and after image inserts with custom properties
Indent codeblocks and admonitions within numbered lists, as the numbers aren't rendered correctly otherwise.
A longer footnote definition.3
Group tabs allow selecting a tab for the whole page. As an example: If a page contains three group tabs with macOS and Windows as options, and you select macOS for one section, then all the sections on the page will switch to macOS.
::::{tabs} :::{group-tab} macOS text ::: :::{group-tab} Windows text ::: ::::
Regular tabs are limited to the section and doesn't affect any other tabs on the page.
::::{tabs} :::{tab} Text 1 text ::: :::{tab} Text 2 text :::
``` This is a codeblock ```
this is in line code
> this is a single line Quote
Add those inline into the text where needed.
[Formatting Cheat Sheet](Formatting_Cheat-Sheet)
{download}`Title<Download_Link>`
Admonitions are boxes with a colored background that highlight information. Available admonition types are: note, warning, tip, caution, attention, danger, error, hint, important, and seealso
:::{<type>} text :::
Admonitions can also be used with custom titles by using the format below.
:::{admonition} Custom Title :class: tip text :::