forked from nextcloud/deck
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Julius Härtl <[email protected]>
- Loading branch information
1 parent
b494e9e
commit 31cf89d
Showing
4 changed files
with
42 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.subnav ul { | ||
padding-left: 20px; | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|