4 ms·

This seems interesting, but I'm not sure what formatting it would actually apply to a given Markdown document - could you add examples to the readme?

shurcooL 12y ago
I've made an example gif for the Atom package: https://raw.githubusercontent.com/shurcooL/atom-markdown-format/master/Demo.gif https://raw.githubusercontent.com/shurcooL/atom-markdown-for... There are also some examples in tests: https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d67c4f6c8dabc498b2697be389d/markdown/main_test.go#L14-L51 https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d6...
- dfc 12y ago
  I can live with condensing numbered lists and removing the blank lines between items. Unwrapping plain text paragraphs is worse but not the end of the world. We start to toe the line with unwrapping my blockquotes. You went way past that line when you removed the empty line at the end of the file.
  - shurcooL 12y ago
    > Unwrapping plain text paragraphs is worse but not the end of the world. We start to toe the line with unwrapping my blockquotes. What do you mean by "unwrapping"? Can you give an example please. I don't think it should be doing any unwrapping; blockquotes should be preserved (and nicely formatted) [1]. > You went way past that line when you removed the empty line at the end of the file. It makes sure the last line has an ending newline, nothing more, nothing less. Any extra newlines are not visible in the generated HTML. [1] https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d67c4f6c8dabc498b2697be389d/markdown/main_test.go#L94-L98 https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d6...
    - dfc 12y ago
      Example text (example.md): Alice wants to conduct a survey of her customers. She wants to restrict access to her customers (ie select subset of people) and she wants customers to be able to answer openly and not worry about reprisals. > Is there a magic token that Alice can distribute to her customers > (Bob,Carol,etc) that demonstrates their membership in survey pool and > protects the anonymity of their responses? Transcript: dfc@ronin:~$ wc example.md 8 67 395 example.md dfc@ronin:~$ .gopath/bin/markdownfmt example.md > gofmt.md dfc@ronin:~$ wc gofmt.md 3 65 390 gofmt.md dfc@ronin:~$ cat gofmt.md Alice wants to conduct a survey of her customers. She wants to restrict a**SNIP** > Is there a magic token that Alice can distribute to her customers (Bob,**SNIP** dfc@ronin:~$ I truncated the lines in the cat gofmt.md because long preformatted colums kill HN readability. That file was 7 lines of pristine markdown with a trailing newline. markdownfmt turned it into three lines total. dfc@ronin:~$ pandoc -t markdown -o pandoc.md example.md dfc@ronin:~$ wc pandoc.md 8 67 395 pandoc.md dfc@ronin:~$ I am not sure what you mean by "It makes sure the last line has an ending newline, nothing more, nothing less. Any extra newlines are not visible in the generated HTML." I thought this was a markdown formatting tool? Here is a hypothetical--but common--workflow that this destroys: Author keeps multiple chapters of book in separate files for easy editing and revision control. When it is time to publish text the author executes: $ cat 1.md 2.md 3.md 4.md |publishmd --some-options You killed my chapter titles.
      - shurcooL 12y ago
        I see, thanks. That's intended behavior. It's related to the decision of whether to enable EXTENSION_HARD_LINE_BREAK, which I've currently left off. So in order to start a new paragraph, you need to leave a empty line in between. It assumes you're using automatic word wrapping in your editor to wrap the paragraphs (this works well if you resize your editor width, or type extra text in the middle of it - the text within the paragraph is reflowed automatically and doesn't go offscreen). I can understand that's a deal-breaker for you if you're not willing to use word wrap in your editor.
        dfc 12y ago
- codezero 12y ago
  I assumed this was kind of a troll until I saw this example. It looks a lot better and seems like a totally valid use case.

shurcooL 12y ago

I've made an example gif for the Atom package: https://raw.githubusercontent.com/shurcooL/atom-markdown-format/master/Demo.gif https://raw.githubusercontent.com/shurcooL/atom-markdown-for... There are also some examples in tests: https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d67c4f6c8dabc498b2697be389d/markdown/main_test.go#L14-L51 https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d6...

dfc 12y ago
I can live with condensing numbered lists and removing the blank lines between items. Unwrapping plain text paragraphs is worse but not the end of the world. We start to toe the line with unwrapping my blockquotes. You went way past that line when you removed the empty line at the end of the file.
- shurcooL 12y ago
  > Unwrapping plain text paragraphs is worse but not the end of the world. We start to toe the line with unwrapping my blockquotes. What do you mean by "unwrapping"? Can you give an example please. I don't think it should be doing any unwrapping; blockquotes should be preserved (and nicely formatted) [1]. > You went way past that line when you removed the empty line at the end of the file. It makes sure the last line has an ending newline, nothing more, nothing less. Any extra newlines are not visible in the generated HTML. [1] https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d67c4f6c8dabc498b2697be389d/markdown/main_test.go#L94-L98 https://github.com/shurcooL/markdownfmt/blob/d472cbc9d6118d6...
  - dfc 12y ago
    Example text (example.md): Alice wants to conduct a survey of her customers. She wants to restrict access to her customers (ie select subset of people) and she wants customers to be able to answer openly and not worry about reprisals. > Is there a magic token that Alice can distribute to her customers > (Bob,Carol,etc) that demonstrates their membership in survey pool and > protects the anonymity of their responses? Transcript: dfc@ronin:~$ wc example.md 8 67 395 example.md dfc@ronin:~$ .gopath/bin/markdownfmt example.md > gofmt.md dfc@ronin:~$ wc gofmt.md 3 65 390 gofmt.md dfc@ronin:~$ cat gofmt.md Alice wants to conduct a survey of her customers. She wants to restrict a**SNIP** > Is there a magic token that Alice can distribute to her customers (Bob,**SNIP** dfc@ronin:~$ I truncated the lines in the cat gofmt.md because long preformatted colums kill HN readability. That file was 7 lines of pristine markdown with a trailing newline. markdownfmt turned it into three lines total. dfc@ronin:~$ pandoc -t markdown -o pandoc.md example.md dfc@ronin:~$ wc pandoc.md 8 67 395 pandoc.md dfc@ronin:~$ I am not sure what you mean by "It makes sure the last line has an ending newline, nothing more, nothing less. Any extra newlines are not visible in the generated HTML." I thought this was a markdown formatting tool? Here is a hypothetical--but common--workflow that this destroys: Author keeps multiple chapters of book in separate files for easy editing and revision control. When it is time to publish text the author executes: $ cat 1.md 2.md 3.md 4.md |publishmd --some-options You killed my chapter titles.
    - shurcooL 12y ago
      I see, thanks. That's intended behavior. It's related to the decision of whether to enable EXTENSION_HARD_LINE_BREAK, which I've currently left off. So in order to start a new paragraph, you need to leave a empty line in between. It assumes you're using automatic word wrapping in your editor to wrap the paragraphs (this works well if you resize your editor width, or type extra text in the middle of it - the text within the paragraph is reflowed automatically and doesn't go offscreen). I can understand that's a deal-breaker for you if you're not willing to use word wrap in your editor.
      - dfc 12y ago
codezero 12y ago
I assumed this was kind of a troll until I saw this example. It looks a lot better and seems like a totally valid use case.