Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arp242/hello-css
A CSS template focused on readability
https://github.com/arp242/hello-css
css css-template
Last synced: 14 days ago
JSON representation
A CSS template focused on readability
- Host: GitHub
- URL: https://github.com/arp242/hello-css
- Owner: arp242
- License: other
- Created: 2019-01-19T01:34:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T09:35:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T20:46:25.630Z (27 days ago)
- Topics: css, css-template
- Language: CSS
- Homepage:
- Size: 412 KB
- Stars: 184
- Watchers: 7
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Hello, CSS!
===========
Hello, CSS! is a CSS template which styles most elements to neutral and
aesthetically pleasing defaults. I copy/pasted variants of this so often I
figured I might as well put a cleaned up and annotated version somewhere.
I encourage you to pick ’n choose what you need, rather than insert everything.
Design principles
-----------------
> Good typography can help your reader devote less attention to the mechanics of
> reading and more attention to your message. Conversely, bad typography can
> distract your reader and undermine your message.
>
> —Matthew Butterick, [*Practical Typography*](https://practicaltypography.com/)
1. Pleasant defaults that should work well for most websites.
2. Main focus is text and good typography.
3. Simplicity matters: easy to extend or modify.
4. Works on all browser, screen sizes, assistive technology, and when printed.
### Example pages.
- [demo/README.html](https://arp242.github.io/hello-css/demo/README.html) (just base.css);
[demo/README-fancy.html](https://arp242.github.io/hello-css/demo/README-fancy.html) (all files).
- My website, [arp242.net](https://arp242.net).
- [GoatCounter](https://www.goatcounter.com) for both the public facing website
as well as the backend (with quite a few additions, but Hello, CSS! as the
base template).
- I reformatted [The Art of Unix programming](https://arp242.net/the-art-of-unix-programming) with this template.
- [My CV](https://arp242.net/cv/CV-MartinTournoij.pdf).
Usage
-----
There are several files, mix-and-match as you want.
There are only a few classes (see the table below); for the most part element
selectors are used (e.g. `blockquote { .. }` instead of `.blockquote { .. }`).
The files are brief and well annotated, and a number of styles have
commented-out alternatives. I encourage you to read and modify to your
preference, rather than blindly copy/paste.
Not every last element is styled. For some things – such as <abbr> – it’s
fine to rely on the browser defaults, small differences are okay. Feel free to
open an issue if you’re missing something in particular.
### HTML example
A typical HTML page might look something like:
Main content
..
Footnotes
..
Feedback
..
Copyright © 2010–2018 Martin Tournoij <[email protected]>
This document is licensed under a
cc-by 4.0 license
.
Also see [start.html](https://github.com/arp242/hello-css/blob/master/start.html).
### Classes
| Class | File | Purpose |
| ------------ | -------------- | -------------------------------------------------------------------------------------- |
| .center | base.css | Center-align the main content. |
| .page | base.css | Main page body. |
| .page-a4 | base.css | A4 page size; useful when producing pages where printing is high priority (e.g. a CV). |
| .page-letter | base.css | U.S. letter page size. |
| .full | base.css | Put a pre, table, or figure element over the full width of a .page, including margins. |
| .border | base.css | Add a border around figure elements. |
| .link | base.css | Format as a link; mainly for buttons, since regular links can't do POST requests. |
| .left | base.css | Left-align a table cell. |
| .right | base.css | Right-align a table cell; the cell will also use tabular numbers for alignment. |
| .postscript | postscript.css | Page content; for e.g. footnotes or feedback section. |
| .vertical | form.css | Layout the form vertically (labels above inputs). |
| .horizontal | form.css | Layout the form horizontally (labels next to inputs). |
### Included files
| File | Description |
| -------------- | ------------------------------------------------ |
| base.css | Basic defaults; this is the bulk of the project. |
| form.css | Forms, inputs, labels (WIP). |
| aside.css | Content in margin. |
| blockquote.css | Decorative quotation marks around blockquote. |
| postscript.css | P.S. content, such as footnotes. |
| permalink.css | Permalink markers in headers. |
The `dist/` directory contains versions without extensive annotations, as well
as an `all.css` which contains all of the above files.
You can use the [singlepage](https://github.com/arp242/singlepage) tool to
inline CSS files in to a document with `` tags.
### Related values (“variables”)
There are a number of variables you can define, they are included at the top of
`base.css`.
| Name | Description | Default |
| -------------- | ----------------------------------------- | ---------------------------------- |
| --font | The main font. | 16px/180% 'Libre Baskerville' (..) |
| --width-body | Width of main body text | 54rem |
| --pad-x | Padding to the side of the body | 4rem |
| --pad-y | Padding to the top and bottom of the body | 1rem |
| --color-bg | Background colour of main body text | #fff |
| --color-text | Colour of main body text | #252525 |
| --color-border | Border colour for table, fieldset, input | #aaa |
See also
--------
- [hello-theme](https://bitbucket.org/jboy1/hello-theme/src/master/), a Pelican
theme based on this (with a few changes).
Credits and license
-------------------
The [Libre Baskerville font](https://github.com/impallari/Libre-Baskerville) in
the fonts directory is distributed under the SIL Open Font License 1.1. See
[fonts/LICENSE](fonts/LICENSE).
The fleurons in the <hr> element are exports from the Deja-Vu font, which
is in the public domain.
<!--
<aside>In my country of The Netherlands it’s not clear if it’s possible to place works in the public domain,
<a href="https://www.iusmentis.com/auteursrecht/publiekdomein/#plaatsen">see this article</a>.
</aside>
-->
Everything else is in the public domain. I renounce all copyright, and don’t
care what you do with it. Since this is not possible in all legal jurisdictions
I’ve also attached a modified copy of the ISC license which replaces the
attribution clause with the text “without any restrictions”:
Copyright © Martin Tournoij
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, without any restrictions.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
---
Cross-platform testing made possible by
[BrowserStack](https://www.browserstack.com/), which provides free access for
open source projects.
[](https://www.browserstack.com/)
<!--
<div class="postscript">
<strong>Footnotes</strong>
<ol>
<li id="fn-1"><p>In my view it’s often better to just copy/paste and modify things, especially when it’s not
inherently complex (like CSS), rather than spending a lot of effort on making it generic, as making software
more generic often comes at the price of increased complexity, maintains burden, and tend to make things
<em>less</em> flexible overall.</p></li>
</ol>
</div>
-->