docs: update readme with zola info

main
CrimsonTome 2023-02-17 03:53:23 +00:00 committed by Rowan Clark
parent 698d5be2dd
commit 6613bae73d
No known key found for this signature in database
GPG Key ID: F620D51904044094
2 changed files with 120 additions and 41 deletions

114
CHANGELOG
View File

@ -1,3 +1,117 @@
Commit: 246450e
Author: Rowan Clark
Fri Feb 17 03:53:23 2023
Commit subject:
docs: update readme with zola info
Commit: 698d5be
Author: Rowan Clark
Fri Feb 17 03:47:37 2023
Commit subject:
remove workflows and add stack to main page
Commit: f00406a
Author: Rowan Clark
Fri Feb 17 03:39:27 2023
Commit subject:
chore: re add theme
Commit: 307c3f6
Author: Rowan Clark
Fri Feb 17 03:25:54 2023
Commit subject:
chore: can build on server now, but no docker
Commit: 775675c
Author: Rowan Clark
Fri Feb 17 03:09:40 2023
Commit subject:
chore: moveover so i can deploy maybe
Commit: a5f4062
Author: Rowan Clark
Fri Feb 17 02:13:35 2023
Commit subject:
fix: potential fix for zola theme not pushing
Commit: 3787d8b
Author: Rowan Clark
Fri Feb 17 01:08:20 2023
Commit subject:
feat: add zola dockerfile
Commit: 36dfd92
Author: Rowan Clark
Fri Feb 17 00:44:51 2023
Commit subject:
remove: rm 11ty files
Commit: 9d9cf6e
Author: Rowan Clark
Fri Feb 17 00:36:12 2023
Commit subject:
feat: transfer imgs
Commit: 37c9e42
Author: Rowan Clark
Fri Feb 17 00:29:15 2023
Commit subject:
feat: add stack
Commit: 6e7f632
Author: Rowan Clark
Fri Feb 17 00:22:12 2023
Commit subject:
chore: remove tag support for now
Commit: 952391a
Author: Rowan Clark
Fri Feb 17 00:18:22 2023
Commit subject:
fix: fix zola, start adding blog archive
Commit: a910301
Author: Rowan Clark
Thu Feb 16 23:00:04 2023
Commit subject:
feat: enable full unicode support
Commit: 1025744
Author: Rowan Clark
Thu Feb 16 22:55:14 2023
Commit subject:
feat: add home menu and enable tags
Commit: cd8ab71
Author: Rowan Clark
Thu Feb 16 22:53:07 2023
Commit subject:
feat: add terminal theme and begin config
Commit: 2212d49
Author: Rowan Clark
Thu Feb 16 22:42:32 2023
Commit subject:
chore: init zola
Commit: 8208d94
Author: Rowan Clark
Tue Feb 14 02:25:14 2023
Commit subject:
chore: switch non-template files from njk to html
Commit: 4d94b0f
Author: Rowan Clark
Tue Feb 14 01:12:55 2023
Commit subject:
feat: fix link colour, begin draft of march's post
Commit: 83c100f
Author: Rowan Clark
Mon Feb 13 23:24:37 2023
Commit subject:
chore: update changelog
Commit: f6c6c7f
Author: Rowan Clark
Mon Feb 13 19:29:12 2023

View File

@ -1,10 +1,8 @@
# CrimsonTome's Blog
> My personal blog documenting my journey into open-source development alongside other things.
> Created with 11ty, hosted in a docker container on my VPS
> Created with Zola, hosted on my VPS
[![CI](https://github.com/CrimsonTome/crimsontome-blog/actions/workflows/node%20CI.yml/badge.svg)](https://github.com/CrimsonTome/crimsontome-blog/actions/workflows/node%20CI.yml)
[![Publish Docker image](https://github.com/CrimsonTome/crimsontome-blog/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/CrimsonTome/crimsontome-blog/actions/workflows/docker-publish.yml)
![Repo Size](https://img.shields.io/github/repo-size/crimsontome/crimsontome-blog)
![Commit Activity /month](https://img.shields.io/github/commit-activity/m/crimsontome/crimsontome-blog)
![Last git commit](https://img.shields.io/github/last-commit/crimsontome/crimsontome-blog)
@ -13,10 +11,7 @@
- [CrimsonTome's Blog](#crimsontomes-blog)
- [Development](#development)
- [Building](#building)
- [Node](#node)
- [Docker](#docker)
- [Dockerfile](#dockerfile)
- [Ouroboros](#ouroboros)
- [Zola](#zola)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
@ -24,47 +19,17 @@
## Development
- clone the repo
- run `npm i` to install dependencies
- `npm run serve`
- run `zola serve` when in `src/blog/`
- make some changes and watch them update in the browser
## Building
### Node
### Zola
- run `npm run build`
- run `zola build` when in `src/blog` (this will only give the right site if your domain matches the base url, Zola is weird like that. serve will work fine)
### Docker
The site can also be built and ran inside a docker container when you are in the base of the repo:
- `sudo docker build -t crimsontome-blog .`
- `sudo docker run -itd -p unused-port-number:80 crimsontome-blog`
- visit `localhost:port` or `ip:port` if you are hosting on a VPS and the site should be available to view
## Dockerfile
```dockerfile
FROM node:18-alpine3.15 as npmpackages
WORKDIR /app
COPY package.json .
RUN npm install
FROM node:18-alpine3.15 as builder
WORKDIR /app
COPY --from=npmpackages /app /app
COPY . .
RUN npm run build
FROM nginx:1.17.10-alpine
RUN rm -r /usr/share/nginx/html/
COPY --from=builder /app/_site/ /usr/share/nginx/html/
```
### Ouroboros
Using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros), you can automatically update containers without the need for restarts. This site is setup with that so you can (instead of building it yourself like above) with `sudo docker run -d -p unused-port-number:80 crimsontome427:crimsontome-blog`
. . Docker instructions may return in the future . .
## Contributing