{"repo":"amirmasoudabdol/preferably","free":true,"listed":false,"github":"https://github.com/amirmasoudabdol/preferably","clone":"git clone https://github.com/amirmasoudabdol/preferably.git","description":"An accessible template for `pkgdown` websites with dynamic light/dark mode support","language":"HTML","stars":62,"topics":["pkgdown","template","theme","bootstrap3","rstats","documentation","static-site-generator","bootstrap5"],"license":null,"category":"docs-static-sites","readme_excerpt":"preferably {preferably} is an accessible template for pkgdown documentation websites. It uses a light and a dark theme and utilizes the prefers-color-scheme CSS variable to automatically serve either of the two based on users' operating system setting, or allowing them to manually toggle between them. Besides offering light and dark mode, I spent some time making the overall reading experience of 'pkgdown' documentations just a bit nicer, by using richer fonts, adopting a better color scheme for codes, etc. Please let me know if you happen to use my template in your project. I'd like to keep a list of websites that are using 'preferably', see here: In the Wild! Installation You can download the stable version from CRAN using install.packages(\"preferably\") , or you may download the development version from GitHub as follow: Usage After the successful installation, if you already have your pkgdown setup ready, you only need to specify the template parameter as follow. Then, as before, you can build your site using build site() and deploy it manually using deploy on branch() . {pkgdown} 2.0 and Bootstrap 5 {preferably} 0.4 is compatible with {pkgdown} 2.0 and Bootstrap 5. In order to build your website using the Bootstrap 5, your setting should look like this: ⚠️ Keep in mind that you should NOT use default assets: false when you change the default template. 'preferably' relies on some of the 'pkgdown' assets and templates. Integration In the case that you are using CI systems t","default_branch":null,"files":null,"tree":[],"storefront":"/r/amirmasoudabdol","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/amirmasoudabdol/preferably/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}