Commit Graph

21 Commits

Author SHA1 Message Date
Uli Schlachter 132aabb402 Fix code block in README
mdl complained about it:

README.md:24: MD046 Code block style
A detailed description of the rules is available at
https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Signed-off-by: Uli Schlachter <psychon@znc.in>
2018-07-07 02:14:57 +02:00
Uli Schlachter 3555b9721d README.md: Remove weird sublists
Instead of using sublists here, it is possible to just start a new
paragraph within the same list item.
2017-11-19 15:16:53 +01:00
Uli Schlachter 6658ccd9c5 README.md: Indent sub-lists with two spaces
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter e8ff8055ba README.md: Try to limit lines to 80 characters
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter 5ecd3e35f2 README.md: Remove two one-entry-lists
Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter 40c8c587a3 README.md: Reformat the python web server call
markdownlint complains about blocks where every line begins with a
dollar sign.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter 7240956520 README.md: Make headline consistent
A headline can have at most the previous headline's level plus one.

Found by markdownlint.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter c8a7b3d520 README.md: Properly mark <img> as code
Otherwise this just inserts a literal <img> tag into the HTML output.

Found by markdownlint.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
Uli Schlachter 9eefa466a9 README.md: Use "1." for all numbered list entries
This fixes a warning produced by markdownlint.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2017-11-19 15:16:53 +01:00
streetturtle 5964d25f14 Fix typos in README (#105) 2017-07-29 23:33:51 +02:00
Jeferson Siqueira e2d09ddca2 Fixing wrong Markdown from README (#65) 2017-01-21 23:23:58 +01:00
Jeferson Siqueira 8e9017ec30 Merging with recipes docs 2017-01-20 20:03:49 -02:00
Jeferson Siqueira bfa779b773 adding information about editig files through github web interface 2017-01-20 14:39:09 -02:00
Jeferson Siqueira 0121bc1171 Adding a guide on how to contribute to the recipes section 2017-01-20 10:35:47 -02:00
Jeferson Siqueira a3ab57a5a4 Merge branch 'master' into site-improvements 2017-01-14 13:58:51 -02:00
aajjbb 46a2bcec9d enhanced docs for screenshot contribution 2017-01-14 13:44:39 -02:00
aajjbb 7bb92ce909 Changing the way screnshots are added in the screen, now they live inside <figure> tags. Also, adding an small doc about how to contribute with screenshots 2017-01-14 13:44:39 -02:00
aajjbb b7a504f6af Changing the way screnshots are added in the screen, now they live inside <figure> tags. Also, adding an small doc about how to contribute with screenshots 2017-01-14 13:44:38 -02:00
Daniel Hahler 69d24b919a Update README: requirements/hacking section (#57) 2017-01-14 01:48:17 +01:00
Uli Schlachter 2ae412a80b Improve README (#41)
This adds some hints on how to build the web page locally and mentions
PerlMagick as a needed dependency (if you want working images).

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-12-25 14:51:09 +01:00
Daniel Hahler 9ba7e14cb2 Add a README (#21) 2016-05-18 10:34:08 +02:00