processwire-recipes / Recipes

Recipe Markdown files
29 stars 18 forks source link

Different field separators in text files? #1

Closed owzim closed 9 years ago

owzim commented 9 years ago

The current separator ---- makes it hard to preview the file in any markdown parser, because it triggers a headline level 2 for all text above it. Any ideas for a different separator, that is readable as such but does not mess with markdown?

marcus-herrmann commented 9 years ago

I'm not that well informed concerning Markdown and all its flavors, but are three (or four) plus signs (++++) still available?

owzim commented 9 years ago

Just tested around a bit, a blank line before and after the separator works just as well, it's more clear anyway:

title: Some Title

----

version: 0.0.1

----

authors: author
owzim commented 9 years ago

We should move from .txt to .md and all recipes should have new lines between content and separators (like in the post above), so this easily previewable/reviewable on GitHub and also better to edit/preview locally with a markdown editor.

I recommend this, becaus with the current pull request by adrian, the recipe is not too readable:

Bad:

bad

Good:

good

marcus-herrmann commented 9 years ago

Agree with both .md and the more readable formatting! Let's add adrian's PR first, then "refactor".

owzim commented 9 years ago

implemented, see https://github.com/processwire-recipes/ProcessRecipeInstaller/commit/94beace35bebf4b98dd6f69cf43e8156a7b29178 and https://github.com/processwire-recipes/Recipes/commit/605b532fdea0e987da3a7a1fb4ec9a411a69904e and https://github.com/processwire-recipes/Recipes/commit/915831f47f787cf7a96f2121dc847f4b13d0d8cd