diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3e6b0fa..aafa64d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,7 +11,7 @@ repos: hooks: - id: conventional-pre-commit stages: [commit-msg] - args: [feat, fix, chore, test, build, merge, refactor] + args: [feat, fix, chore, test, build, merge, refactor, doc] - repo: local hooks: - id: eslint diff --git a/README.md b/README.md index 7cc754f..53b403e 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,18 @@ To insert custom content, create a directory with a similar structure to directory. The website will be built statically in `build/`. Note that changing `favicon.svg` will require modifying the `static/` folder. +Set `metadata.json` based on the example to have a custom avatar and background +image. +- `name`: Displayed name on the home page +- `blogName`: Displayed name of the blog +- `url`: The site url +- `frontDescription`: The text above the main navbar +- `frontCover`: Path to the cover image +- `picture`: Avatar +- `links`: A map of brands to links +- `extra`: Extra pages showing on the navbar +- `markdown`: `{ "highlighterLangs": [ ... ], "katex": [ ... ] }` + ## Developing Install [pre-commit](https://pre-commit.com/).