Hacker News new | ask | show | jobs
by roznoshchik 1586 days ago
I added an install.md now for setting it up locally. Does that work for you?
1 comments

Nice. Tip: format it as a shell code block on markdown

Also eval adding a Dockerfile for super-rapid deploy

Thanks. I'll probably look into a dockerfile option.

Does format as a shell code block mean write it in a way that it can just be copied and pasted easily?

Github has pretty comprehensive documentation on their flavor of markdown used for formatting; Here's a direct link to the section on fenced code blocks: https://github.github.com/gfm/#fenced-code-blocks
It'll format it as monospace, and typically in a format that's easier to recognize as being code.

IIRC you can do that by gating code like this:

  '''
  code goes here
  '''
in markdown, but it's been a while.

(The spaces are necessary for HN markup, but not the markdown formatting).