mirror of
https://github.com/andwati/andwati.com.git
synced 2026-10-18 09:22:53 +00:00
improved README.md
This commit is contained in:
@@ -1,2 +1,62 @@
|
||||
# My Digital Garden
|
||||
[](https://app.netlify.com/sites/andwati/deploys)
|
||||
# https://andwati.com
|
||||
|
||||
[](https://app.netlify.com/sites/andwati/deploys)
|
||||
|
||||
MY personal page and blog site.
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
## 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 [email protected]: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)
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
Reference in New Issue
Block a user