Markdown Syntax Throughout the Wiki

[bromiley]

As we're reformatting and adding new content, I have a quick question about code blocks. Should we be using indentation or code blocks via backticks or tildes? The output will look the same but more consistent if some guidelines are set up front. Thanks!

[simsong]

I like spaces for a few lines of code and backticks for code blocks. I don't think that it really matters.

[joachimmetz]

I would opt fenced code blocks with triple back-ticks (```) and code type indicator, it looks like this is most widely adopted.

• https://www.mkdocs.org/user-guide/writing-your-docs/#fenced-code-blocks
• https://python-markdown.github.io/extensions/fenced_code_blocks/

[joachimmetz]

What "weird combination" (that is supported by mkdocs) did you have in mind? <pre>...</pre> ?

[simsong]

Well, DFXML is XML, and ``` is markdown.

[joachimmetz]

how does that relate to forensics wiki mkdocs style preference for code blocks?

[simsong]

I thought we were talking about DFXML. Sorry.

[joachimmetz]

Maybe delete this thread?