Update README.md

This commit is contained in:
cedricve
2021-07-15 16:57:18 +02:00
parent fc97166a23
commit af6a21c8cd

View File

@@ -2,19 +2,22 @@
And so it began. The documentation of the entire Kerberos.io ecosystem.
Master branch
> [doc.kerberos.io](https://doc.kerberos.io)
Develop branch
> [staging.doc.kerberos.live](https://staging.doc.kerberos.live)
## Development
Install dependencies
$ yarn install
Run Hugo dev server with autocompile of assets
Run Hugo dev server with auto compile of assets
$ yarn start
## Formatting notes
**YouTube/Vimeo**
@@ -27,15 +30,11 @@ Using Hugo's built-in video shortcodes ([source](https://gohugo.io/content-manag
- keep the `responsive-video` class intact
- use `ratio-16by10` or `ratio-4by3` class to fix aspect ratio if video is different than 16:9
## TODO
- config/_default/params.toml
- [ ] open:graph image
- [ ] schema logo
- before launch
- [ ] change baseURL in config/production/config.toml
- nice to haves:
- [ ] transform colors to CSS vars (and use for easier dark mode)