Skip to content

Site Rules

redtide edited this page Sep 2, 2021 · 2 revisions
  • Start any .md file with a 2 triple-dashed lines front matter, otherwise Jekyll will copy the original md file into the resulting _site directory instead converting it to HTML.

  • All page contents must have a title specified in the front matter, not using '#', because the title sets also the one on the web browser window. If you don't want to display it in the page use:

    no_h1_title: true
  • Use 2 spaces indentation instead of tabs, please use EditorConfig for this.

  • Use 80 characters per line limit for a better reading.

  • Don't use '<' and '>' in md files to avoid the parser to generate wrong html code, use '‹' and '›' instead or surround them with backticks.

  • Use https links, avoid http mixed content.

  • Don't use inline links like this:

    Follow [this link](https://someurl.com) and also [this interesting one](https://interesting-one.com).
    

    do:

    Follow [this link] and also [this interesting one].
    
    <!-- at the bottom of the page after 2 blank lines, vertically aligned: -->
    [this link]:            https://someurl.com
    [this interesting one]: https://interesting-one.com
    

    or:

    Follow [this link][1] and also [this interesting one][2].
    
    <!-- at the bottom of the page after 2 blank lines, vertically aligned: -->
    [1]: https://someurl.com
    [2]: https://interesting-one.com
    
Clone this wiki locally