diff --git a/README.md b/README.md index 0941655..77aaec7 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,39 @@ Orignally created to move my recipes from a local flash drive to a small and sim This website is going to be turned into something bigger, like a blog site of sorts. Subdomain is going to be changed to musings., writings., articles., blog., works., or something more appropriate. [TBD/TODO] + +# Project Structure + +## layouts + +### _default + +TBD + +### partials + +TBD + +### Short Codes + +Short codes provide code utility in content files. They can call partials but not other short codes. + +`comment.html` is intentionally blank, it allows comments in content files which do nothing. + +For block comments, use `hide.html` such as: + +``` +{{< hide >}} +lalala + +this is markdown content + +# secret section not published yet + +super duper unfinished content +{{< /hide >}} +``` + +### posts + +Layouts specifically related to content under `/posts/` diff --git a/layouts/shortcodes/README.md b/layouts/shortcodes/README.md deleted file mode 100644 index 07cd229..0000000 --- a/layouts/shortcodes/README.md +++ /dev/null @@ -1,17 +0,0 @@ -Short codes provide code utility in content files. They can call partials but not other short codes. - -`comment.html` is intentionally blank, it allows comments in content files which do nothing. - -For block comments, use `hide.html` such as: - -``` -{{< hide >}} -lalala - -this is markdown content - -# secret section not published yet - -super duper unfinished content -{{< /hide >}} -```