From 23876c5420c20292966367659708a200c8668f96 Mon Sep 17 00:00:00 2001 From: gennyble Date: Thu, 22 Feb 2024 04:12:40 -0600 Subject: Minimum viable --- readme.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index c7a1258..b7a3651 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,11 @@ +# For Later +**Single-tile weather radar** +Using the RainViewer API for the radar and an OpenStreetMap tileserver for the +map tile. Make a gif with a few frames of radar so we can embed it on the site. + +Zoomed out far enough that I'm not worried about opsec and with no marker for +where I am in the tile. + ## Dirfiles These are files that match the name of the directory. @@ -10,4 +18,50 @@ the directory name changes. What do you name the root file, then? You shouldn't have to match the webroot's directory name. Perhaps it should be configurable. I think for now we'll -hard-code in `home.html`, though. \ No newline at end of file +hard-code in `home.html`, though. + +## Page-content uses templates +Because writing the same outer-html for everything poses a few problems. I'll +enumerate them for fun! +1) it makes keeping a consistent page style difficult. +2) making a style change or renaming a core-stylesheet would require going + through and editing a large number of files. +3) helps separate the layout and content of the page. + +We're using the bempline templating engine. Not because it's the best or even +really *that good*, but because I wrote it and I like it :) + +Page-content files will have frontmatter in the form: +``` +--- +key=value +--- +``` + +blank lines and comments are acceptable. comments are lines starting with a `#` + +with these keys being common and defined. + +**title** (default: filename) +the `` of the page + +== TODO: THE BELOW IS DREAMING == + +**og_title** (default: page title) +the opengraph title of the webpage + +**og_type** (default: website) +TODO: not currently implemented. everything is a website. + +**og_description** (default: none) +a one or two sentence description of the page. + +```html +<!-- required tags. us an image requried? i do not have one.--> +<meta property="og:title" content="nyble.dev | gone" /> +<meta property="og:type" content="website" /> +<meta property="og:url" content="https://nyble.dev/" /> + +<!-- not required but helps make better cards, etc. --> +<meta property="og:description" content="gone for now. stepped out for a bit." /> +``` \ No newline at end of file -- cgit 1.4.1-3-g733a5