Ask Your Question
8

[Sticky] How do I better format my questions and answers to make them more readable?

asked 2011-11-24 17:54:32 -0600

shaiton gravatar image

updated 2018-11-16 11:39:41 -0600

hhlp gravatar image

Hi, is there a good resource to get more markdown?

How to know which one are implemented?

How to include references, as[1]?

How to highlight the inline code? (the only way is not backquote).

How to include a spoiler, when we want to hide some "not so useful" explanations?

[1] http://en.wikipedia.org/wiki/Markdown

edit retag flag offensive close merge delete

Comments

Please edit the question topic, its not good. Thanks.

lzap gravatar imagelzap ( 2011-11-25 03:52:52 -0600 )edit

@lzap any proposal? I didn't get a better one (without 20 words). Should I add just " on ask.fpo"?

shaiton gravatar imageshaiton ( 2011-11-25 05:21:14 -0600 )edit

@FranciscoD_ thanks, the question is far more comprehensive :)

shaiton gravatar imageshaiton ( 2013-08-05 09:24:58 -0600 )edit

2 Answers

Sort by » oldest newest most voted
12

answered 2011-11-24 17:55:32 -0600

shaiton gravatar image

updated 2013-08-25 05:51:58 -0600

Actually here is what I found:


italic using *italic*, bold using **bold**, even more with ***more***. Works also with '_' markup instead of '*'.

Link

  • A link with [link](http://ask.fedoraproject.org "ask")
  • You could also link to Bugzilla ticket like bug#680990 by simply writing bug#680990.
  • Even linking to last koji build like build#294566 by simply writing build#294566.
  • Use wiki:url to link to the Fedora Project "url" wiki page
  • packagedb:packageName links to http://bugz.fedoraproject.org/packageName

Code

Inline code by surrounding code with backquotes (`)

A block code could is defined by a newline begining with four blank spaces. Or included between <pre> </pre> tags:

# Code example
su -c 'yum shell'
> install git
> groupinstall 'Web Server'
> run

Heading

# First level (h1)

## Second level (h2)

### Third level (h3)

We could also underline them:

Big, same as h1

===

Medium, same as h2

---


Lists

  • Start a new line using a minus (-), or an asterisk (*), or a plus sign (+).
    • To get a nested list, indent by four spaces.
 
  1. Numeric lists
  2. is done by starting with 1. You don't need to count.
    1. Sublists are indented with four blank spaces.

Quote

Start a new line with > to create a blockquote.

Here I define a new blockquote

References

Link to other an other question: duplicate of #251, using [#251](/question/251/)

Image

Same as for links, but with the '!' before.

![Fedora logo](https://fedoraproject.org/w/uploads/e/e5/Fedora_infinity.png "infty")

You have to use the html form if you need to define its size:

`<img alt="Fedora Logo" src="https://fedoraproject.org/w/uploads/e/e5/Fedora_infinity.png" width="100" height="100">`

In comments

Reply to someone is done by adding @ before its pseudo (e.g. @shaiton). He will be notified.

You could also use code highlighting there. Hint, press [shift]+[Enter] if you want to add a new line.

edit flag offensive delete link more

Comments

Is it also possible to link to a thread on the fedora forum? like forum#1234

Jann5s gravatar imageJann5s ( 2013-08-18 12:30:51 -0600 )edit

The line "Write question#XXXX to link an other question from ask.fpo" is incorrect, at least it did not work when I tried it. However, a different method suggested later on does work e.g. "Link to other an other question: duplicate of #251, using [#251](/question/251/)"

Jann5s gravatar imageJann5s ( 2013-08-20 12:36:25 -0600 )edit

@Jann5s oops, you're right it is only in staging actually, will correct, thanks

shaiton gravatar imageshaiton ( 2013-08-25 05:51:16 -0600 )edit

no, you need to copy the whole URL to fedoraforum.

shaiton gravatar imageshaiton ( 2013-08-25 07:45:17 -0600 )edit
3

answered 2011-11-25 03:53:59 -0600

lzap gravatar image

I also recommend to install vim plugin for markdown if you are happy user of this excelent editor. It has nice syntax highlighting that visually guide you somehow:

https://github.com/tpope/vim-markdown

edit flag offensive delete link more

Comments

nice plugin, thanks.

shaiton gravatar imageshaiton ( 2011-11-25 05:25:08 -0600 )edit
1

@lzap Do consider packaging it.

mether gravatar imagemether ( 2012-02-16 09:31:11 -0600 )edit

Question Tools

4 followers

Stats

Asked: 2011-11-24 17:54:32 -0600

Seen: 4,203 times

Last updated: Aug 25 '13