https://github.com/cynkra/cynkratemplate
pkgdown template repo for cynkra packages
https://github.com/cynkra/cynkratemplate
Last synced: 26 days ago
JSON representation
pkgdown template repo for cynkra packages
- Host: GitHub
- URL: https://github.com/cynkra/cynkratemplate
- Owner: cynkra
- License: other
- Created: 2020-05-12T21:16:28.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T12:09:10.000Z (12 months ago)
- Last Synced: 2024-05-02T05:57:18.661Z (12 months ago)
- Language: R
- Homepage: https://cynkratemplate.cynkra.com/
- Size: 4.49 MB
- Stars: 1
- Watchers: 11
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - cynkra/cynkratemplate - pkgdown template repo for cynkra packages (R)
README
# cynkratemplate
[](https://www.tidyverse.org/lifecycle/#maturing)
This is a custom, restricted template for use by cynkra packages.
Please don't use it for your own package.
## Usage
Install cynkratemplate.
```r
devtools::install_github("cynkra/cynkratemplate")
```
Run
```r
cynkratemplate::use_cynkra_pkgdown()
```
Please ask the person in charge (see website page of the general manual in clickup) for a plausible subdomain via email or another mean of communication of their choice.
## Fonts
Our private "Frutiger" fonts are hosted on AWS in the "cynkraweb" S3 bucket.
Some browsers (e.g. Firefox) block the font access if the "CORS" headers are not set correctly.
To allow access, the domain needs to be whitelisted within the CORS configuration block of the S3 bucket.
In addition, he ACL settings of the bucket must be set to "public read" so the files can actually be accessed in the first place.
### cynkra blog, dm and similar repositories
The *cynkra blog*, *cynkratemplate*, *dm* and similar repositories use the same fonts from [cynkra/cynkraweb on GitHub](https://github.com/cynkra/cynkraweb/blob/main/www/user/_fonts.scss), specifically `font-family: "frutiger", sans-serif;` with font weights of `300` (light), `400` (normal), and `700` (bold). Please ensure not to use **500**, **600**, **bolder**, or other weights, as the browser would render them using faux styles.
Keep in mind that since the Cynkra blog loads fonts from absolute URLs (e.g. `src: url("https://cynkra.com/assets/css/fonts/6135829/b05d44ef-6a78-4aa4-9388-3f0e05252a48.woff2") format("woff2");`), if there is a font update at the [cynkra/cynkraweb GitHub repository](https://github.com/cynkra/cynkraweb/), the URLs might change, requiring updates on our end as well.
### Local preview
To see the Frutiger fonts within local previews, you need to allow CORS for localhost files.
This setting is usually off in most browsers and will hence block resources from a different origin.
As the fonts are served via AWS S3, the origin differs from localhost.
For Chromium-based browsers, the "CORS Unblock" extension does the job.
There should be similar extensions for Firefox and other browsers.
Safari is less strict with CORS and should serve the Frutiger font by default.