Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thara authored Mar 3, 2024
1 parent a3cd636 commit b7705bf
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,19 @@ My personal web site, hosting at https://thara.dev

## Requirements

- go 1.x later
- [just](https://github.com/casey/just)
- pandoc 2.19 later

## Usage

### Serve the generated site locally

`just serve`
`make clean serve`

### Deploy via GitHub Action

The GitHub Action ([publish.yml](./.github/workflows/publish.yml)) is available to
build and deploy automatially.
The GitHub Action ([publish.yml](./.github/workflows/publish.yml)) is available to build and deploy automatially.

- `master` branch (Source)
- `gh-pages` branch (GitHub Pages)

## Note

### Markdown frontmatter

| key | description |
| ---- | ------------|
| title | page title |
| date | page created timestamp (used as order in post list) |
| path | overwrite destination path |

### Templating

- pages/posts/*.md -> templates/post.html
- pages/*.md -> templates/base.html

## Author

Tomochika Hara

0 comments on commit b7705bf

Please sign in to comment.