https://github.com/rosettatype/design-regression
An online journalette about letters, design, and reading
https://github.com/rosettatype/design-regression
academic article design journal letters typeface
Last synced: 2 months ago
JSON representation
An online journalette about letters, design, and reading
- Host: GitHub
- URL: https://github.com/rosettatype/design-regression
- Owner: rosettatype
- License: other
- Created: 2020-05-22T08:11:19.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T18:52:56.000Z (6 months ago)
- Last Synced: 2024-12-05T19:34:32.030Z (6 months ago)
- Topics: academic, article, design, journal, letters, typeface
- Language: SCSS
- Homepage: http://designregression.com
- Size: 49 MB
- Stars: 7
- Watchers: 7
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Design Regression
Design Regression is a journalette (mini journal) publishing texts that are about design for reading and reading-related research. It aims for the hard-to-get blend of approachability with seriousness and relevance to practice.
## Licence
The articles are licensed under a [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International licence (CC BY-NC-ND 4.0)](https://creativecommons.org/licenses/by-nc-nd/4.0/).
Rosetta reserves all rights regarding the website design and fonts used.
## Adding content
The site is built from the Markdown (.md) files in this repository and hosted on Github pages. To add a new article add a new file in the `_posts` directory and follow the pattern of existing posts:
- name the file by date and title, without spaces or non-ascii characters
- set the article metadata in the "Front Matter" (between the `---`)
- author your article in the [Markdown syntax](https://www.markdownguide.org/tools/jekyll/)
- to preview your edits:
- you need [Ruby](https://www.ruby-lang.org) installed on your system
- ~~install Jekyll locally, run `gem install`~~~
- install the required gems by running `bundle install` (you may need to install bundler first with `gem install bundler`)
- run the Jekyll site locally with `bundle exec jekyll serve`
- the local preview server address is output to the terminal, usually something like:
> Server address: http://127.0.0.1:4000/
- to stop the server, press `control + c`
- when you are happy with your edits, make a commit and push it to Github
### Development
The project is built with static site generator [Jekyll](https://jekyllrb.com/). You will require Ruby to run and preview the site locally before committing any changes to the repository. To run a local preview follow the steps above under "Adding content".
To recompile or update the icon fonts, you need to separately install the `fontcustom` gem and re-compile (after editing or adding SVG files in `/icons`):
```
gem install fontcustom
fontcustom compile
```
The styles in `/assets/css` automatically get compiled from the `scss` [Sass](https://sass-lang.com/) files.
`/layouts` and `/includes` contain the template files of the site. `_data` contains additional data to build the navigation and other metadata. `/_config.yml` holds the site configuration and `/_site` is the pre-built static version of the compiled site for local previewing (it should be excluded from the repo).
NOTE: While the `_config.yml` `baseurl` is defined for github pages to work correctly the local preview will return a 404 frontpage; simply click the header logo link once to get to the "real" frontpage.