Ticket #737 (new enhancement)

Opened 4 years ago

Last modified 2 years ago

Markdown syntax summary page

Reported by: dread Owned by:
Priority: awaiting triage Milestone: ckan-backlog
Component: ckan Keywords: ux
Cc: Repository: ckan
Theme: none

Description

I suggest we produce a quick Markdown cheat-sheet page, showing the key runes: e.g. create a title and quote some text. This page can link to the full Markdown docs for advanced users.

A user going to the Markdown docs that we link will have to read a couple of pages of the raison-d'etre of Markdown before he gets to the syntax. And it's not very easy to read, and being white on black it looks like proper geek stuff.

Change History

comment:1 Changed 3 years ago by dread

  • Priority set to awaiting triage
  • Type changed from task to enhancement
  • Component set to ckan

comment:2 Changed 3 years ago by dread

  • Repository set to ckan
  • Theme set to none

Something like this one on github:

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
Text styles
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__

*You **can** combine them*
Lists
Unordered
* Item 1
* Item 2
  * Item 2a
  * Item 2b
Ordered
1. Item 1
2. Item 2
3. Item 3
   * Item 3a
   * Item 3b
Miscellaneous
Images
![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)
Links
http://github.com - automatic!
[GitHub](http://github.com)
Blockquotes
As Kanye West said:
> We're living the future so
> the present is our past.

comment:3 Changed 2 years ago by shevski

  • Keywords ux added
  • Milestone set to ckan-backlog
Note: See TracTickets for help on using tickets.