kerberos-io/documentation
1
0
Fork 0
mirror of https://github.com/kerberos-io/documentation.git synced 2026-08-23 15:18:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
cedricve
2021-07-15 16:57:18 +02:00
parent fc97166a23
commit af6a21c8cd
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

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