bobdenotter / bolt-tufte-theme
🎨 Tufte Theme for Bolt
Installs: 6
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 4
Language:SCSS
Type:bolt-theme
This package is auto-updated.
Last update: 2024-09-30 01:35:41 UTC
README
Simplicity, to me, has always been the essence of good taste.
-- Cary Grant
Edward Tufte uses a distinctive style in his handouts: simple, with well-set
typography, extensive sidenotes, and tight integration of graphics and
charts. tufte-css
brings that style to HTML documents.
This project is directly inspired by and based on Tufte-LaTeX and the R Markdown Tufte Handout.
A good starting point for the 'entries' contenttype is:
entries:
name: Entries
singular_name: Entry
fields:
title:
type: text
class: large
group: content
slug:
type: slug
uses: title
teaser:
type: html
height: 150px
image:
type: image
group: media
attrib: [ title, alt ]
image_position:
type: select
values:
main: "Main column"
sidebar: "Sidebar"
body:
type: html
height: 300px
taxonomy: [ categories, tags ]
listing_records: 10
default_status: publish
sort: -datepublish
Getting Started
The file index.html is a self-describing demonstration document that walks through the features of Tufte CSS. The live version at http://www.daveliepmann.com/tufte-css/ is the best overview of the project.
To use Tufte CSS on your own HTML page, just copy tufte.css
,
ETBembo-RomanLF.ttf
, and ETBembo-DisplayItalic.ttf
to your project
directory and add the following to your HTML doc's head block:
<link rel="stylesheet" href="tufte.css"/>
All the other files can be ignored, as they are merely used by the demonstration document.
Contributing
If you notice something wrong or broken, let us know by opening an issue. Pull requests are very welcome.
For best results, keep pull requests to one change at a time, and
test your fix or new functionality against index.html
on screens as
small as an iPhone 4 and as big as, well, as big as you use
normally. (If you don't have a mobile device handy, fake different
devices with your browser's developer tools.) See the Issues page, especially
Help Wanted,
for opportunities to contribute. Keep our style guide in mind:
CSS Style Guide
Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.
-- Google Style Guide
Tufte CSS aims for clarity, concision, and uniformity. Here's a basic example of our CSS conventions:
p { font-size: 1.4rem; line-height: 2rem; margin-top: 1.4rem; margin-bottom: 1.4rem; width: 55%; padding-right: 0; vertical-align: baseline; } @media screen and (max-width: 600px) { p { width: 70%; }} @media screen and (max-width: 400px) { p { width: 90%; }}
Notice the single spacing between most syntactic markers, the single blank lines between unrelated blocks, and the absence of line breaks after an open-paren and before end-parens. Notice also that these rules change slightly for media queries.
Originally adapted from : https://github.com/daveliepmann/tufte-css, by Dave Liepmann.
License
Released under the MIT license. See LICENSE.TXT.