Skip to content

Site Rules

redtide edited this page Feb 25, 2021 · 1 revision
  • 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.

    Opcode files should include:

    • a layout: sfz/opcode variable to specify the required layout to build the resulting html page
    • the page language code if it's not English
    • optionally, the title of the page if different than the page name (see the example below).
  • Each opcode file must have also an entry in the [syntax.yml] db file.

  • Using block code three back ticks even with a single line, inline code is used for opcode keywords highlights.

  • Using spaces instead of tabs for indentation in pages, mostly on _config.yml to avoid issues / unwanted results.

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

  • Using a naming convention for numbered opcodes starting with N following with X Y Z, e.g.: egN_timeX_onccY

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