diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 43 insertions, 8 deletions
@@ -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` |