summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteph Enders <steph@senders.io>2024-02-29 09:31:15 -0500
committerSteph Enders <steph@senders.io>2024-02-29 09:31:15 -0500
commit2b39175011422a0d8f96d7f598f46e2a781dd28f (patch)
treedd896a1e35e2ec194bfce829afd61f553652464a /README.md
parent350a5058cf383733a7e75f753abdcd1cb7aae2c5 (diff)
Initial rework commit: Build Script POC and CSS done
I've created the main CSS layout and a proof of concept for the build script: this will actually build any "done" _post/ file and generate it as a workable HTML file. However, no index file generate, rss, or gemini is implemented
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 43 insertions, 8 deletions
diff --git a/README.md b/README.md
index bed830b..269d7c1 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,47 @@
-# senders-io
-Personal Homepage, Blog, Resume
+# senders.io
-# run locally
-To run this locally you'll just need docker!
+This is the repo for my personal website. It's not much but it's mine.
-`$ ./docker-run.sh` will launch an `nginx` server with the contents of `www` loaded into server and can be accessed at [http://localhost]
+## Structure
-# deploy
-To deploy run `./deploy.sh` this will require the AWS CLI to be configured properly, so make sure your creds are setup in the environment.
+`./build.sh` builds the site - generates a `www` and `gemini` folder!
+`_posts` is where the posts go!
+`_templates` are where the templates are for file generation
+`static-html` all the HTML files that are, well, static and can be copied as written
+`static-gemini` all the gemtext files that are, also, static and can be copied as written
+`res` all the resources! These will end up in `www/media`
-It will also commit and create the `www/version.txt` file with the date of deployment.
+## Posting
+
+Once a post is drafted and ready: `--post-date: [ISO-DATE]` can be added to the top of the file for it to get picked up from the build script.
+
+## Metadata
+
+The current supported metadata tags are:
+
+- `--post-date: ISO-DATE`
+- `--updated-at: ISO-DATE`
+- `--tags: [ CSV ]` (see tags below)
+- `--type: ??` - What type of post is this? a blog post, etc?
+
+### Tags
+
+For my own reference I currently plan to have:
+
+- `food`
+- `tech`
+- `music`
+- `personal`
+
+### Types
+
+- None
+- `blog`
+
+## Dependencies
+
+- `GNU sed`
+- `mktemp`
+- `GNU grep`
+- `bash`
+- `python 3`