feat: More icons and custom highlighter languages #35
|
@ -11,7 +11,7 @@ repos:
|
||||||
hooks:
|
hooks:
|
||||||
- id: conventional-pre-commit
|
- id: conventional-pre-commit
|
||||||
stages: [commit-msg]
|
stages: [commit-msg]
|
||||||
args: [feat, fix, chore, test, build, merge, refactor]
|
args: [feat, fix, chore, test, build, merge, refactor, doc]
|
||||||
- repo: local
|
- repo: local
|
||||||
hooks:
|
hooks:
|
||||||
- id: eslint
|
- id: eslint
|
||||||
|
|
12
README.md
12
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
|
directory. The website will be built statically in `build/`. Note that changing
|
||||||
`favicon.svg` will require modifying the `static/` folder.
|
`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
|
## Developing
|
||||||
|
|
||||||
Install [pre-commit](https://pre-commit.com/).
|
Install [pre-commit](https://pre-commit.com/).
|
||||||
|
|
Loading…
Reference in New Issue