From b811761c0026e5fd4fac15cc806e9bef971d73ee Mon Sep 17 00:00:00 2001 From: Hau Nguyen Date: Mon, 11 Jul 2022 11:26:24 +0700 Subject: [PATCH] feat: use goldmark and minify --- custom/head.html | 20 ---- docs/2022-06-08-backup.html | 136 +--------------------- docs/2022-06-08-dockerfile-go.html | 106 ++--------------- docs/2022-07-10-bootstrap-go.html | 175 +---------------------------- docs/index.html | 50 +-------- docs/styles.css | 1 + go.mod | 7 +- go.sum | 18 ++- main.go | 135 ++++++++++++++++------ templates/post.html | 16 +++ templates/styles.css | 9 ++ 11 files changed, 163 insertions(+), 510 deletions(-) delete mode 100644 custom/head.html create mode 100644 docs/styles.css create mode 100644 templates/post.html create mode 100644 templates/styles.css diff --git a/custom/head.html b/custom/head.html deleted file mode 100644 index 3b3d31a..0000000 --- a/custom/head.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - -Back to index diff --git a/docs/2022-06-08-backup.html b/docs/2022-06-08-backup.html index 31ea627..3ba6cee 100644 --- a/docs/2022-06-08-backup.html +++ b/docs/2022-06-08-backup.html @@ -1,138 +1,6 @@ - - - - 2022-06-08-backup.md - - - - - - - - -Back to index - - - - - -

Backup my way

- -

First thing first, I want to list my own devices, which I have through the years:

- - - -

App/Service I use daily:

- - - -

The purpose is that I want my data to be safe, secure, and can be easily recovered if I lost some devices; -or in the worst situation, I lost all. -Because you know, it is hard to guess what is waiting for us in the future.

- -

There are 2 sections which I want to share, the first is How to backup, the second is Recover strategy.

- -

How to backup

- -

Before I talk about backup, I want to talk about data. -In specifically, which data should I backup?

- -

I use Arch Linux and macOS, primarily work in the terminal so I have too many dotfiles, for example, ~/.config/nvim/init.lua. -Each time I reinstall Arch Linux (I like it a lot), I need to reconfigure all the settings, and it is time-consuming.

- -

So for the DE and UI settings, I keep it as default as possible, unless it’s getting in my way, I leave the default setting there and forget about it. -The others are dotfiles, which I write my own dotfiles tool to backup and reconfigure easily and quickly. -Also, I know that installing Arch Linux is not easy, despite I install it too many times (Like thousand times since I was in high school). -Not because it is hard, but as life goes on, the official install guide keeps getting new update and covering too many cases for my own personal use, so I write my own guide to quickly capture what I need to do. -I back up all my dotfiles inside my dotfiles tool in GitHub and GitLab as I trust them both. -Also as I travel the Internet, I discover Codeberg and Treehouse and use them as another backup for git repo.

- -

So that is my dotfiles, for my regular data, like Wallpaper or Books, Images, I use Google Drive (Actually I pay for it). -But the step: open the webpage, click the upload button and choose files seems boring and time-consuming. -So I use Rclone, it supports Google Drive, One Drive and many providers but I only use Google Drive for now. -The commands are simple:

- -
# Sync from local to remote
+

Backup my way

First thing first, I want to list my own devices, which I have through the years:

  • Laptop Samsung NP300E4Z-S06VN (Old laptop which I give to my mom)
  • Laptop Dell Inspiron 15 3567 (My mom bought it for me when I go to college, I give it to my sister afterward)
  • Laptop Acer Nitro AN515-45 (Gaming laptop which I buy for gaming, of course)
  • MacBook Pro M1 2020 (My company laptop)
  • Phone Xiaomi Poco X3 NFC (Primary phone which I use daily)

App/Service I use daily:

The purpose is that I want my data to be safe, secure, and can be easily recovered if I lost some devices;
or in the worst situation, I lost all.
Because you know, it is hard to guess what is waiting for us in the future.

There are 2 sections which I want to share, the first is How to backup, the second is Recover strategy.

How to backup

Before I talk about backup, I want to talk about data.
In specifically, which data should I backup?

I use Arch Linux and macOS, primarily work in the terminal so I have too many dotfiles, for example, ~/.config/nvim/init.lua.
Each time I reinstall Arch Linux (I like it a lot), I need to reconfigure all the settings, and it is time-consuming.

So for the DE and UI settings, I keep it as default as possible, unless it's getting in my way, I leave the default setting there and forget about it.
The others are dotfiles, which I write my own dotfiles tool to backup and reconfigure easily and quickly.
Also, I know that installing Arch Linux is not easy, despite I install it too many times (Like thousand times since I was in high school).
Not because it is hard, but as life goes on, the official install guide keeps getting new update and covering too many cases for my own personal use, so I write my own guide to quickly capture what I need to do.
I back up all my dotfiles inside my dotfiles tool in GitHub and GitLab as I trust them both.
Also as I travel the Internet, I discover Codeberg and Treehouse and use them as another backup for git repo.

So that is my dotfiles, for my regular data, like Wallpaper or Books, Images, I use Google Drive (Actually I pay for it).
But the step: open the webpage, click the upload button and choose files seems boring and time-consuming.
So I use Rclone, it supports Google Drive, One Drive and many providers but I only use Google Drive for now.
The commands are simple:

# Sync from local to remote
 rclone sync MyBooks remote:MyBooks -P --exclude .DS_Store
 
 # Sync from remote to local
 rclone sync remote:MyBooks MyBooks -P --exclude .DS_Store
-
- -

Before you use Rclone to sync to Google Drive, you should read Google Drive rclone configuration first.

- -

The next data is my passwords and my OTPs. -These are the things which I’m scare to lose the most. -First thing first, I enable 2-Step Verification for all of my important accounts, should use both OTP and phone method.

- -

I use Bitwarden for passwords (That is a long story, coming from Google Password manager to Firefox Lockwise and then settle down with Bitwarden) and Aegis for OTPs. -The reason I choose Aegis, not Authy (I use Authy for so long but Aegis is definitely better) is because Aegis allows me to extract all the OTPs to a single file (Can be encrypted), which I use to transfer or backup easily.

- -

As long as Bitwarden provides free passwords stored, I use all of its apps, extensions so that I can easily sync passwords between laptops and phones. -The thing I need to remember is the master password of Bitwarden in my head.

- -

With Aegis, I export the data, then sync it to Google Drive, also store it locally in my phone. -For safety, I also store Aegis data locally on all of my laptops (Encrypted of course).

- -

The main problem here is the OTP, I can not store all of my OTPs in the cloud completely. -Because if I want to access my OTPs in the cloud, I should log in, and then input my OTP, this is a circle, my friends.

- -

Recovery strategy

- -

There are many strategies that I process to react as if something strange is happening to my devices.

- -

If I lost my laptops, single laptop or all, do not panic as long as I have my phones. -The OTPs are in there, the passwords are in Bitwarden cloud, other data is in Google Drive so nothing is lost here.

- -

If I lost my phone, but not my laptops, I use the OTPs which are stored locally in my laptops.

- -

In the worst situation, I lost everything, my laptops, my phone. -The first step is to recover my SIM, then log in to Google account using the password and SMS OTP. -After that, log in to Bitwarden account using the master password and OTP from Gmail, which I open previously.

- -

The end

- -

This guide will be updated regularly I promise.

- - - +

Before you use Rclone to sync to Google Drive, you should read Google Drive rclone configuration first.

The next data is my passwords and my OTPs.
These are the things which I'm scare to lose the most.
First thing first, I enable 2-Step Verification for all of my important accounts, should use both OTP and phone method.

I use Bitwarden for passwords (That is a long story, coming from Google Password manager to Firefox Lockwise and then settle down with Bitwarden) and Aegis for OTPs.
The reason I choose Aegis, not Authy (I use Authy for so long but Aegis is definitely better) is because Aegis allows me to extract all the OTPs to a single file (Can be encrypted), which I use to transfer or backup easily.

As long as Bitwarden provides free passwords stored, I use all of its apps, extensions so that I can easily sync passwords between laptops and phones.
The thing I need to remember is the master password of Bitwarden in my head.

With Aegis, I export the data, then sync it to Google Drive, also store it locally in my phone.
For safety, I also store Aegis data locally on all of my laptops (Encrypted of course).

The main problem here is the OTP, I can not store all of my OTPs in the cloud completely.
Because if I want to access my OTPs in the cloud, I should log in, and then input my OTP, this is a circle, my friends.

Recovery strategy

There are many strategies that I process to react as if something strange is happening to my devices.

If I lost my laptops, single laptop or all, do not panic as long as I have my phones.
The OTPs are in there, the passwords are in Bitwarden cloud, other data is in Google Drive so nothing is lost here.

If I lost my phone, but not my laptops, I use the OTPs which are stored locally in my laptops.

In the worst situation, I lost everything, my laptops, my phone.
The first step is to recover my SIM, then log in to Google account using the password and SMS OTP.
After that, log in to Bitwarden account using the master password and OTP from Gmail, which I open previously.

The end

This guide will be updated regularly I promise. \ No newline at end of file diff --git a/docs/2022-06-08-dockerfile-go.html b/docs/2022-06-08-dockerfile-go.html index 612aaeb..4ff7b30 100644 --- a/docs/2022-06-08-dockerfile-go.html +++ b/docs/2022-06-08-dockerfile-go.html @@ -1,48 +1,4 @@ - - - - 2022-06-08-dockerfile-go.md - - - - - - - - -Back to index - - - -

- -

Dockerfile for Go

- -

Each time I start a new Go project, I repeat many steps. -Like set up .gitignore, CI configs, Dockerfile, …

- -

So I decide to have a baseline Dockerfile like this:

- -
FROM golang:1.18-bullseye as builder
+

Dockerfile for Go

Each time I start a new Go project, I repeat many steps.
Like set up .gitignore, CI configs, Dockerfile, ...

So I decide to have a baseline Dockerfile like this:

FROM golang:1.18-bullseye as builder
 
 RUN go install golang.org/dl/go1.18@latest \
     && go1.18 download
@@ -61,67 +17,19 @@ FROM gcr.io/distroless/base-debian11
 COPY --from=builder /build/app /app
 
 ENTRYPOINT ["/app"]
-
- -

I use multi-stage build to keep my image size small. -First stage is Go official image, -second stage is Distroless.

- -

Before Distroless, I use Alpine official image, -There is a whole discussion on the Internet to choose which is the best base image for Go. -After reading some blogs, I discover Distroless as a small and secure base image. -So I stick with it for a while.

- -

Also, remember to match Distroless Debian version with Go official image Debian version.

- -
FROM golang:1.18-bullseye as builder
-
- -

This is Go image I use as a build stage. -This can be official Go image or custom image is required in some companies.

- -
RUN go install golang.org/dl/go1.18@latest \
+

I use multi-stage build to keep my image size small.
First stage is Go official image,
second stage is Distroless.

Before Distroless, I use Alpine official image,
There is a whole discussion on the Internet to choose which is the best base image for Go.
After reading some blogs, I discover Distroless as a small and secure base image.
So I stick with it for a while.

Also, remember to match Distroless Debian version with Go official image Debian version.

FROM golang:1.18-bullseye as builder
+

This is Go image I use as a build stage.
This can be official Go image or custom image is required in some companies.

RUN go install golang.org/dl/go1.18@latest \
     && go1.18 download
-
- -

This is optional. -In my case, my company is slow to update Go image so I use this trick to install latest Go version.

- -
WORKDIR /build
+

This is optional.
In my case, my company is slow to update Go image so I use this trick to install latest Go version.

WORKDIR /build
 
 COPY go.mod .
 COPY go.sum .
 COPY vendor .
 COPY . .
-
- -

I use /build to emphasize that I am building something in that directory.

- -

The 4 COPY lines are familiar if you use Go enough. -First is go.mod and go.sum because it defines Go modules. -The second is vendor, this is optional but I use it because I don’t want each time I build Dockerfile, I need to redownload Go modules.

- -
RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GOAMD64=v3 go build -o ./app -tags timetzdata -trimpath .
-
- -

This is where I build Go program.

- -

CGO_ENABLED=0 because I don’t want to mess with C libraries. -GOOS=linux GOARCH=amd64 is easy to explain, Linux with x86-64. -GOAMD64=v3 is new since Go 1.18, -I use v3 because I read about AMD64 version in Arch Linux rfcs. TLDR’s newer computers are already x86-64-v3.

- -

-tags timetzdata to embed timezone database incase base image does not have. --trimpath to support reproduce build.

- -
FROM gcr.io/distroless/base-debian11
+

I use /build to emphasize that I am building something in that directory.

The 4 COPY lines are familiar if you use Go enough.
First is go.mod and go.sum because it defines Go modules.
The second is vendor, this is optional but I use it because I don't want each time I build Dockerfile, I need to redownload Go modules.

RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GOAMD64=v3 go build -o ./app -tags timetzdata -trimpath .
+

This is where I build Go program.

CGO_ENABLED=0 because I don't want to mess with C libraries.
GOOS=linux GOARCH=amd64 is easy to explain, Linux with x86-64.
GOAMD64=v3 is new since Go 1.18,
I use v3 because I read about AMD64 version in Arch Linux rfcs. TLDR's newer computers are already x86-64-v3.

-tags timetzdata to embed timezone database incase base image does not have.
-trimpath to support reproduce build.

FROM gcr.io/distroless/base-debian11
 
 COPY --from=builder /build/app /app
 
 ENTRYPOINT ["/app"]
-
- -

Finally, I copy app to Distroless base image.

- - - +

Finally, I copy app to Distroless base image. \ No newline at end of file diff --git a/docs/2022-07-10-bootstrap-go.html b/docs/2022-07-10-bootstrap-go.html index d2915df..2d951bb 100644 --- a/docs/2022-07-10-bootstrap-go.html +++ b/docs/2022-07-10-bootstrap-go.html @@ -1,76 +1,4 @@ - - - - 2022-07-10-bootstrap-go.md - - - - - - - - -Back to index - - - -

- -

Bootstrap Go

- -

It is hard to write bootstrap tool to quickly create Go service. -So I write this guide instead. -This is a quick checklist for me every damn time I need to write a Go service from scratch. -Also, this is my personal opinion, so feel free to comment.

- -

Structure

- -
main.go
+

Bootstrap Go

It is hard to write bootstrap tool to quickly create Go service.
So I write this guide instead.
This is a quick checklist for me every damn time I need to write a Go service from scratch.
Also, this is my personal opinion, so feel free to comment.

Structure

main.go
 internal
 | business_1
 | | http
@@ -92,103 +20,4 @@ internal
 | | | service.go
 | | | repository.go
 | | | models.go
-
- -

All business codes are inside internal. -Each business has a different directory (business_1, business_2).

- -

Inside each business, there are 2 handlers: http, grpc:

- -
    -
  • http is for public APIs (Android, iOS,… are clients).
  • -
  • grpc is for internal APIs (other services are clients).
  • -
- -

Inside each handler, there are usually 3 layers: handler, service, repository:

- -
    -
  • handler interacts directly with gRPC or REST using specific codes (cookies,…)
  • -
  • service is where we write business/logic codes, and only business/logic codes is written here.
  • -
  • repository is where we write codes which interacts with database/cache like MySQL, Redis, …
  • -
- -

handler must exist inside grpc, http. -But service, repository, models can exist directly inside business if both grpc, http has same business/logic.

- -

Do not repeat!

- -

If we have too many services, some of the logic will be overlapped.

- -

For example, service A and service B both need to make POST call API to service C. -If service A and service B both have libs to call service C to do that API, we need to move the libs to some common pkg libs. -So in the future, service D which needs to call C will not need to copy libs to handle service C api but only need to import from common pkg libs.

- -

Another bad practice is adapter service. -No need to write a new service if what we need is just common pkg libs.

- -

External libs

- -

Don’t use cli libs (spf13/cobra, urfave/cli) just for Go service

- -

What is the point to pass many params (--abc, --xyz) when what we only need is start service?

- -

In my case, service starts with only config, and config should be read from file or environment like The Twelve Factors guide.

- -

Don’t use grpc-ecosystem/grpc-gateway

- -

Just don’t.

- -

Use protocolbuffers/protobuf-go, grpc/grpc-go for gRPC.

- -

Write 1 for both gRPC, REST sounds good, but in the end, it is not worth it.

- -

Don’t use uber/prototool, use bufbuild/buf

- -

prototool is deprecated, and buf can generate, lint, format as good as prototool.

- -

Use gin-gonic/gin for REST.

- -

Don’t use gin.Context when pass context from handler layer to service layer, use gin.Context.Request.Context() instead.

- -

If you want log, just use uber-go/zap

- -

It is fast!

- -
    -
  • Don’t overuse func (*Logger) With. Because if log line is too long, there is a possibility that we can lost it.

  • - -
  • Use MarshalLogObject when we need to hide some field of object when log (field has long or sensitive value)

  • - -
  • Don’t use Panic. Use Fatal for errors when start service to check dependencies. If you really need panic level, use DPanic.

  • - -
  • Use contextID or traceID in every log lines for easily debug.

  • -
- -

Don’t overuse ORM libs, no need to handle another layer above SQL.

- -

Each ORM libs has each different syntax. -To learn and use those libs correctly is time consuming. -So just stick to plain SQL. -It is easier to debug when something is wrong.

- -

But database/sql has its own limit. -For example, it is hard to get primary key after insert/update. -So may be you want to use ORM for those cases.

- -

If you want test, just use stretchr/testify.

- -

It is easy to write a suite test, thanks to testify. -Also, for mocking, there are many options out there. -Pick 1 then sleep peacefully.

- -

Replace go fmt, goimports with mvdan/gofumpt.

- -

gofumpt provides more rules when format Go codes.

- -

Use golangci/golangci-lint.

- -

No need to say more. -Lint or get the f out!

- - - +

All business codes are inside internal.
Each business has a different directory (business_1, business_2).

Inside each business, there are 2 handlers: http, grpc:

Inside each handler, there are usually 3 layers: handler, service, repository:

handler must exist inside grpc, http.
But service, repository, models can exist directly inside business if both grpc, http has same business/logic.

Do not repeat!

If we have too many services, some of the logic will be overlapped.

For example, service A and service B both need to make POST call API to service C.
If service A and service B both have libs to call service C to do that API, we need to move the libs to some common pkg libs.
So in the future, service D which needs to call C will not need to copy libs to handle service C api but only need to import from common pkg libs.

Another bad practice is adapter service.
No need to write a new service if what we need is just common pkg libs.

External libs

Don't use cli libs (spf13/cobra, urfave/cli) just for Go service

What is the point to pass many params (--abc, --xyz) when what we only need is start service?

In my case, service starts with only config, and config should be read from file or environment like The Twelve Factors guide.

Don't use grpc-ecosystem/grpc-gateway

Just don't.

Use protocolbuffers/protobuf-go, grpc/grpc-go for gRPC.

Write 1 for both gRPC, REST sounds good, but in the end, it is not worth it.

Don't use uber/prototool, use bufbuild/buf

prototool is deprecated, and buf can generate, lint, format as good as prototool.

Use gin-gonic/gin for REST.

Don't use gin.Context when pass context from handler layer to service layer, use gin.Context.Request.Context() instead.

If you want log, just use uber-go/zap

It is fast!

Don't overuse ORM libs, no need to handle another layer above SQL.

Each ORM libs has each different syntax.
To learn and use those libs correctly is time consuming.
So just stick to plain SQL.
It is easier to debug when something is wrong.

But database/sql has its own limit.
For example, it is hard to get primary key after insert/update.
So may be you want to use ORM for those cases.

If you want test, just use stretchr/testify.

It is easy to write a suite test, thanks to testify.
Also, for mocking, there are many options out there.
Pick 1 then sleep peacefully.

Replace go fmt, goimports with mvdan/gofumpt.

gofumpt provides more rules when format Go codes.

Use golangci/golangci-lint.

No need to say more.
Lint or get the f out! \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 5bcb6b9..ea4ff3e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,49 +1 @@ - - - - index.md - - - - - - - - -Back to index - - - -

- -

Index

- -

This is where I dump my thoughts.

- - - - - +

Index

This is where I dump my thoughts.

\ No newline at end of file diff --git a/docs/styles.css b/docs/styles.css new file mode 100644 index 0000000..bae6287 --- /dev/null +++ b/docs/styles.css @@ -0,0 +1 @@ +body{font-family:recursive,sans-serif;font-variation-settings:"MONO" 0,"CASL" 1}code{font-family:recursive,monospace;font-variation-settings:"MONO" 1,"CASL" 1} \ No newline at end of file diff --git a/go.mod b/go.mod index b5186e9..726170d 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,9 @@ module github.com/haunt98/posts-go go 1.18 -require github.com/gomarkdown/markdown v0.0.0-20220627144906-e9a81102ebeb +require ( + github.com/tdewolff/minify/v2 v2.12.0 + github.com/yuin/goldmark v1.4.13 +) + +require github.com/tdewolff/parse/v2 v2.6.1 // indirect diff --git a/go.sum b/go.sum index 0b1f954..650f5d3 100644 --- a/go.sum +++ b/go.sum @@ -1,2 +1,16 @@ -github.com/gomarkdown/markdown v0.0.0-20220627144906-e9a81102ebeb h1:5b/eFaSaKPFG9ygDBaPKkydKU5nFJYk08g9jPIVogMg= -github.com/gomarkdown/markdown v0.0.0-20220627144906-e9a81102ebeb/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA= +github.com/cheekybits/is v0.0.0-20150225183255-68e9c0620927/go.mod h1:h/aW8ynjgkuj+NQRlZcDbAbM1ORAbXjXX77sX7T289U= +github.com/djherbis/atime v1.1.0/go.mod h1:28OF6Y8s3NQWwacXc5eZTsEsiMzp7LF8MbXE+XJPdBE= +github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= +github.com/fsnotify/fsnotify v1.5.4/go.mod h1:OVB6XrOHzAwXMpEM7uPOzcehqUV2UqJxmVXmkdnm1bU= +github.com/matryer/try v0.0.0-20161228173917-9ac251b645a2/go.mod h1:0KeJpeMD6o+O4hW7qJOT7vyQPKrWmj26uf5wMc/IiIs= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/tdewolff/minify/v2 v2.12.0 h1:ZyvMKeciyR3vzJrK/oHyBcSmpttQ/V+ah7qOqTZclaU= +github.com/tdewolff/minify/v2 v2.12.0/go.mod h1:8mvf+KglD7XurfvvFZDUYvVURy6bA/r0oTvmakXMnyg= +github.com/tdewolff/parse/v2 v2.6.1 h1:RIfy1erADkO90ynJWvty8VIkqqKYRzf2iLp8ObG174I= +github.com/tdewolff/parse/v2 v2.6.1/go.mod h1:WzaJpRSbwq++EIQHYIRTpbYKNA3gn9it1Ik++q4zyho= +github.com/tdewolff/test v1.0.6/go.mod h1:6DAvZliBAAnD7rhVgwaM7DE5/d9NMOAJ09SqYqeK4QE= +github.com/tdewolff/test v1.0.7 h1:8Vs0142DmPFW/bQeHRP3MV19m1gvndjUb1sn8yy74LM= +github.com/tdewolff/test v1.0.7/go.mod h1:6DAvZliBAAnD7rhVgwaM7DE5/d9NMOAJ09SqYqeK4QE= +github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= diff --git a/main.go b/main.go index a69fb34..b38e913 100644 --- a/main.go +++ b/main.go @@ -1,22 +1,41 @@ package main import ( + "bytes" + "io" "log" "os" "path/filepath" "strings" + "text/template" - "github.com/gomarkdown/markdown" - "github.com/gomarkdown/markdown/html" + "github.com/tdewolff/minify/v2" + minify_css "github.com/tdewolff/minify/v2/css" + minify_html "github.com/tdewolff/minify/v2/html" + "github.com/yuin/goldmark" + gm_extension "github.com/yuin/goldmark/extension" + gm_html "github.com/yuin/goldmark/renderer/html" ) const ( - postsPath = "posts" - headHTMLPath = "custom/head.html" + postFilesPath = "posts" + templatePostPath = "templates/post.html" + + templateCSSPath = "templates/styles.css" + cssFilename = "styles.css" + generatedPath = "docs" - htmlExt = ".html" + + extHTML = ".html" + + mimeTypeHTML = "text/html" + mimeTypeCSS = "text/css" ) +type templatePostData struct { + Body string +} + func main() { // Cleanup generated path if err := os.RemoveAll(generatedPath); err != nil { @@ -27,47 +46,99 @@ func main() { log.Fatalln("Failed to mkdir all", generatedPath) } - // Read needed files - headHTML, err := os.ReadFile(headHTMLPath) + // Read post files directory + postFiles, err := os.ReadDir(postFilesPath) if err != nil { - log.Fatalln("Failed to read file", headHTML) + log.Fatalln("Failed to read dir", postFilesPath) } - files, err := os.ReadDir(postsPath) + // Prepare template + templatePostBytes, err := os.ReadFile(templatePostPath) if err != nil { - log.Fatalln("Failed to read dir", postsPath) + log.Fatalln("Failed to read file", templatePostPath, err) } - for _, file := range files { - if file.IsDir() { + templatePost, err := template.New("post").Parse(string(templatePostBytes)) + if err != nil { + log.Fatalln("Failed to parse template", err) + } + + // Prepare parse markdown + gm := goldmark.New( + goldmark.WithExtensions( + gm_extension.GFM, + ), + goldmark.WithRendererOptions( + gm_html.WithHardWraps(), + ), + ) + + // Prepare minify + m := minify.New() + m.AddFunc(mimeTypeHTML, minify_html.Minify) + m.AddFunc(mimeTypeCSS, minify_css.Minify) + + // Generate post files + for _, postFile := range postFiles { + if postFile.IsDir() { continue } - // Generate HTML - filePath := filepath.Join(postsPath, file.Name()) - md, err := os.ReadFile(filePath) + // Prepare post file + mdFilename := filepath.Join(postFilesPath, postFile.Name()) + mdFileBytes, err := os.ReadFile(mdFilename) if err != nil { - log.Fatalln("Failed to read file", filePath) + log.Fatalln("Failed to read file", mdFilename, err) } - htmlFlags := html.CommonFlags | - html.CompletePage | - html.TOC | - html.LazyLoadImages - htmlRendererOtps := html.RendererOptions{ - Title: file.Name(), - Head: headHTML, - Flags: htmlFlags, + // Prepare html file + htmlFilename := strings.TrimSuffix(postFile.Name(), filepath.Ext(postFile.Name())) + extHTML + htmlFilepath := filepath.Join(generatedPath, htmlFilename) + + htmlFile, err := os.OpenFile(htmlFilepath, os.O_RDWR|os.O_CREATE, 0o600) + if err != nil { + log.Fatalln("Failed to open file", htmlFilepath, err) } - htmlRenderer := html.NewRenderer(htmlRendererOtps) - generatedHTML := markdown.ToHTML(md, nil, htmlRenderer) - - generatedFileName := strings.TrimSuffix(file.Name(), filepath.Ext(file.Name())) + htmlExt - generatedFilePath := filepath.Join(generatedPath, generatedFileName) - - if err := os.WriteFile(generatedFilePath, generatedHTML, 0o666); err != nil { - log.Fatalln("Failed to write file", generatedFilePath, err) + // Parse markdown + var markdownBuf bytes.Buffer + if err := gm.Convert(mdFileBytes, &markdownBuf); err != nil { + log.Fatalln("Failed to convert markdown", err) } + + tmpReader, tmpWriter := io.Pipe() + + // Template + go func() { + if err := templatePost.Execute(tmpWriter, templatePostData{ + Body: markdownBuf.String(), + }); err != nil { + log.Fatalln("Failed to execute html template", err) + } + tmpWriter.Close() + }() + + // Minify + if err := m.Minify(mimeTypeHTML, htmlFile, tmpReader); err != nil { + log.Fatalln("Failed to minify html", err) + } + tmpReader.Close() + htmlFile.Close() + } + + // Copy css file + templateCSSFile, err := os.OpenFile(templateCSSPath, os.O_RDONLY, 0o600) + if err != nil { + log.Fatalln("Failed to open file", templateCSSPath, err) + } + + cssFilename := filepath.Join(generatedPath, cssFilename) + cssFile, err := os.OpenFile(cssFilename, os.O_RDWR|os.O_CREATE, 0o600) + if err != nil { + log.Fatalln("Failed to open file", cssFilename, err) + } + + if err := m.Minify(mimeTypeCSS, cssFile, templateCSSFile); err != nil { + log.Fatalln("Failed to minify css", err) } } diff --git a/templates/post.html b/templates/post.html new file mode 100644 index 0000000..cb5a86c --- /dev/null +++ b/templates/post.html @@ -0,0 +1,16 @@ + + + + + + + + + + + {{.Body}} + + diff --git a/templates/styles.css b/templates/styles.css new file mode 100644 index 0000000..3d26e3b --- /dev/null +++ b/templates/styles.css @@ -0,0 +1,9 @@ +body { + font-family: "Recursive", sans-serif; + font-variation-settings: "MONO" 0, "CASL" 1; +} + +code { + font-family: "Recursive", monospace; + font-variation-settings: "MONO" 1, "CASL" 1; +}