diff --git a/_example/README.md b/_example/README.md deleted file mode 100644 index 9a7224f619191edd2bcdf5d9f5acc90976f2e60d..0000000000000000000000000000000000000000 --- a/_example/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Example blog structure - -The `articles` dir contains a list of articles, namely this one. - -The `templates` dir contains a handful of [go templates](https://pkg.go.dev/html/template) that make up how to render the blog. -- `article.tmpl` is a template for an individual article (this page). -- `index.tmpl` is the main blog overview. -- `base.tmpl` is a collection of [defined blocks](https://pkg.go.dev/text/template#hdr-Nested_template_definitions) -that are then re-used in `index.tmpl` and `article.tmpl` to create a cohesive look-and-feel. - -Finally, `config.yaml` (which can also be TOML if desired) allows you to not have to continuously re-type all the flags to define things like your -`--article-dir`, `--template-dir`, or `--out`. - diff --git a/_example/articles/introduction.md b/_example/articles/introduction.md index 67956be729182b0ac63aa2360d99554f7152f141..dbfe7bdf145abbcdae98620c1d7638e23697ba7e 100644 --- a/_example/articles/introduction.md +++ b/_example/articles/introduction.md @@ -15,9 +15,6 @@ Truly cutting edge, I know. Never seen one of these before, have you? --- -summary: "An introduction of `blog`" - ---- time: 2024-02-17 package main @@ -51,18 +48,3 @@ def main(): print("Hello, blog!") ``` - -## tl;dr - -Check out the [example](https://git.jolheiser.com/blog/tree/main/_example). - -The `articles` dir contains a list of articles, namely this one. - -The `templates` dir contains a handful of [go templates](https://pkg.go.dev/html/template) that make up how to render the blog. -- `article.tmpl` is a template for an individual article (this page). -- `index.tmpl` is the main blog overview. -- `base.tmpl` is a collection of [defined blocks](https://pkg.go.dev/text/template#hdr-Nested_template_definitions) -that are then re-used in `index.tmpl` and `article.tmpl` to create a cohesive look-and-feel. - -Finally, `config.yaml` (which can also be TOML if desired) allows you to not have to continuously re-type all the flags to define things like your -`--article-dir`, `--template-dir`, or `--out`. diff --git a/_example/config.yaml b/_example/config.yaml deleted file mode 100644 index 914646cc3ba1a16edd9b65861c517ff51634acc7..0000000000000000000000000000000000000000 --- a/_example/config.yaml +++ /dev/null @@ -1,9 +0,0 @@ -article-dir: articles -template-dir: templates -out-dir: out -author: - name: jolheiser - email: john+blog@jolheiser.com - links: - - name: GitHub - url: "https://github.com/jolheiser" diff --git a/_example/templates/base.tmpl b/_example/templates/base.tmpl index 7a05f6c9c322f6db80c4885b595f3a2c944552ee..a089ae02dcc490efe40f367e703a87220e1e80a8 100644 --- a/_example/templates/base.tmpl +++ b/_example/templates/base.tmpl @@ -4,5 +4,20 @@