Skip to content

Commit

Permalink
Restructure docs
Browse files Browse the repository at this point in the history
Signed-off-by: Julius Härtl <[email protected]>
  • Loading branch information
juliusknorr committed Nov 6, 2018
1 parent b494e9e commit 31cf89d
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 21 deletions.
27 changes: 27 additions & 0 deletions docs/Markdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## What is Markdown

The [wikipedia markdown entry](https://en.wikipedia.org/wiki/Markdown) introduced markdown as :

> Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. As the initial description of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown appeared over the years to answer these issues.
## Markdown in Deck
The Deck application plugin uses the [markdown-it](https://github.com/markdown-it/markdown-it) script to offer support for markdown in the cards description field.

## Supported Markdown

Markdown comes in may flavors. The best way to learn markdown and understand how to use it, is simply to [try it](https://markdown-it.github.io) on the original script official playground.
That same link offers also a comprehensive list of what is supported, and what is not - rendering it unnecessary to duplicate that content in here.

[CommonMark Markdown Reference](http://commonmark.org/help/)

## Known Issues

As per [issue #127](https://github.com/nextcloud/deck/issues/127) Due to a known limitation of the current script to support markdown, Links that contain the `")"` character will not display well, or will break.
The recommended solution is to use `"<"` and `">"` to wrap those links. It should assure their integrity.
If you come by another case of broken link, or broken display of links, please report it by opening a new issue.






3 changes: 3 additions & 0 deletions docs/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.subnav ul {
padding-left: 20px;
}
17 changes: 0 additions & 17 deletions docs/index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/index.md
15 changes: 11 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
site_name: Nextcloud Deck
theme: readthedocs
markdown_extensions:
- toc:
permalink: True
theme:
name: readthedocs
extra_css: [extra.css]
nav:
- Home: index.md
- User documentation:
- Markdown composing: Markdown.md
- API documentation:
- REST API: API.md
- Nextcloud API: API-Nextcloud.md

0 comments on commit 31cf89d

Please sign in to comment.