diff --git a/README.md b/README.md index bb7a40b..0841c85 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,62 @@ -# My Digital Garden -[![Netlify Status](https://api.netlify.com/api/v1/badges/471edaff-df82-49b0-87c4-0027d02c9784/deploy-status)](https://app.netlify.com/sites/andwati/deploys) \ No newline at end of file +# https://andwati.com + +[![Netlify Status](https://api.netlify.com/api/v1/badges/471edaff-df82-49b0-87c4-0027d02c9784/deploy-status)](https://app.netlify.com/sites/andwati/deploys) + +MY personal page and blog site. +![home](/screenshots/home.png) +![posts](/screenshots/posts.png) +![archive](/screenshots/archive.png) +![about](/screenshots/about.png) + +## Features + +- [-] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar. +- [x] Support for comments using utterances +- [x] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO). +- [-] [KaTeX](https://katex.org/) support. +- [x] [feed](https://andwati.com/rss.xml). +- [x] [Archive page](https://andwati.com/archive/). +- [x] [Tags](<(https://andwati.com/tags/)>) +- [x] Responsive design. +- [x] Code syntax highlighting. +- [-] Newsletter +- [x] Word Count and Reading time +- [x] Pagination + +# Generating the site + +## Steps + +1. Clone this site and enter the directory. + +``` +repo='andwati.com'; git clone git@github.com:andwati/${repo}.git && cd $repo +``` + +2. Install or update to the latest Zola. + +``` +make update-zola +``` + +or install zola from [Github](https://github.com/getzola/zola) + +3. Build the site! + +``` +make build +``` + +or + +``` +zola build +``` + +# Inspiration + +This website was inspired by [gruvbox](https://github.com/morhetz/gruvbox),[Reilly Tucker Siemens](https://github.com/reillysiemens/tuckersiemens.com) and many more. + +# License + +This repo is licensed under [MIT License](./LICENSE) diff --git a/screenshots/about.png b/screenshots/about.png new file mode 100644 index 0000000..661e16f Binary files /dev/null and b/screenshots/about.png differ diff --git a/screenshots/archive.png b/screenshots/archive.png new file mode 100644 index 0000000..31352a8 Binary files /dev/null and b/screenshots/archive.png differ diff --git a/screenshots/home.png b/screenshots/home.png new file mode 100644 index 0000000..7050dc6 Binary files /dev/null and b/screenshots/home.png differ diff --git a/screenshots/posts.png b/screenshots/posts.png new file mode 100644 index 0000000..15b22a1 Binary files /dev/null and b/screenshots/posts.png differ