Skip to content

Commit

Permalink
add markdown linting (#28)
Browse files Browse the repository at this point in the history
* add linter

* add ci

* update readme for pre-commit

---------

Co-authored-by: robhowley <rhowley@seatgeek.com>
  • Loading branch information
robhowley and robhowley authored Aug 6, 2024
1 parent bc6d730 commit 05b682a
Show file tree
Hide file tree
Showing 41 changed files with 90 additions and 54 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: CI
on:
push:

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: articulate/actions-markdownlint@v1
with:
config:
files: .markdownlint.yaml
version: 0.41.0
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
.sass-cache
Gemfile.lock
_site
.jekyll-metadata
.jekyll-metadata
2 changes: 2 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
MD013:
line_length: 120
13 changes: 13 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
hooks:
- id: markdownlint
args:
- "--disable"
- MD033
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
betterby.bike
betterby.bike
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Runs on [git pages](https://pages.github.com/) using [jekyll](https://jekyllrb.c

## Local dev

Can run locally using docker compose. Run
### Running site locally

```
docker compose up
Expand All @@ -19,3 +19,11 @@ docker compose up
and go to [localhost:4000](http://localhost:4000/). Changes to the _content_ will live reload.

_Note_: changes to the `_config.yml`, e.g. theme, or the `Gemfile` will require restarting the container.

### pre-commit

The linting steps that run in CI are available as pre-commit checks as well. To set them up run

```shell
pre-commit install
```
1 change: 0 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@ footer_links:
- title: Facebook
url: https://www.facebook.com/profile.php?id=61560900343761
icon: fab fa-facebook

2 changes: 1 addition & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
- title: Search
url: /search/
- title: Contact
url: /contact/
url: /contact/
4 changes: 2 additions & 2 deletions _myth-busting/bikes-income-inequality.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ American Community Survey confirms this and also shows that these people skew lo
This result shouldn't be surprising given that the _cost of car ownership is now over $1,000 per month_ according to
AAA.

#### Source
#### Source

* Low-Income Americans Walk and Bike to Work the Most
* [pdf](/images/news/2014-streetsblog-income-biking.pdf)
* [original link](https://usa.streetsblog.org/2014/05/08/low-income-americans-walk-and-bike-to-work-the-most)

* What Is the Total Cost of Owning a Car?
* [pdf](/images/news/2024-nerd-wallet-cost-car-ownership.pdf)
* [original link](https://www.nerdwallet.com/article/loans/auto-loans/total-cost-owning-car)
* [original link](https://www.nerdwallet.com/article/loans/auto-loans/total-cost-owning-car)
6 changes: 3 additions & 3 deletions _myth-busting/short-car-trips.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ car trips really are.

| Trip distance | % of trips |
|:--------------------|:----------:|
| Less than 0.5 miles | 3.8% |
| 1 mile | 12.6% |
| Less than 0.5 miles | 3.8% |
| 1 mile | 12.6% |
| 2 miles | 11.3% |
| 3 miles | 10.7% |
| 4 miles | 7.5% |
Expand All @@ -29,4 +29,4 @@ car trips really are.
Many car trips are short local drives that are well within biking distance especially when the growing popularity of
e-bikes is factored in.

_Source_: [FOTW #1042, August 13, 2018: In 2017 Nearly 60% of All Vehicle Trips Were Less than Six Miles](https://www.energy.gov/eere/vehicles/articles/fotw-1042-august-13-2018-2017-nearly-60-all-vehicle-trips-were-less-six)
_Source_: [FOTW #1042, August 13, 2018: In 2017 Nearly 60% of All Vehicle Trips Were Less than Six Miles](https://www.energy.gov/eere/vehicles/articles/fotw-1042-august-13-2018-2017-nearly-60-all-vehicle-trips-were-less-six)
2 changes: 1 addition & 1 deletion _pages/business.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Bikes are good for business
layout: category
taxonomy: Business
permalink: /business/
---
---
2 changes: 1 addition & 1 deletion _pages/categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ layout: categories
permalink: /categories/
show_excerpts: true
entries_layout: list
---
---
2 changes: 1 addition & 1 deletion _pages/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ If you're on a social media hiatus, no worries, you can use
Whichever method you choose, you can be attributed in the subsequents post(s) if desired. All good work deserves a
shoutout.

Thanks!
Thanks!
2 changes: 1 addition & 1 deletion _pages/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Improving the environment
layout: category
taxonomy: Environment
permalink: /environment/
---
---
2 changes: 1 addition & 1 deletion _pages/in-the-news.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Bike research in the news
layout: category
taxonomy: In the news
permalink: /in-the-news/
---
---
2 changes: 1 addition & 1 deletion _pages/posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ layout: posts
permalink: /research-summaries/
show_excerpts: true
entries_layout: list
---
---
2 changes: 1 addition & 1 deletion _pages/safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Improved safety for all
layout: category
taxonomy: Safety
permalink: /safety/
---
---
2 changes: 1 addition & 1 deletion _pages/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Search
layout: search
permalink: /search/
sitemap: false
---
---
2 changes: 1 addition & 1 deletion _pages/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ layout: tags
permalink: /tags/
show_excerpts: true
entries_layout: list
---
---
4 changes: 2 additions & 2 deletions _posts/biz/2012-10-01-measuring-street.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ business, maybe even great.

* 9th Ave protected bike lane

* retail sales up 49% after
* retail sales up 49% after

* rest of Manhattan up only 3%

Expand All @@ -21,4 +21,4 @@ business, maybe even great.

* rest of Manhattan vacancies down only 5%

_Source_: [Measuring the street](/images/research/2012-10-measuring-the-street.pdf), NYC DOT, 2012
_Source_: [Measuring the street](/images/research/2012-10-measuring-the-street.pdf), NYC DOT, 2012
2 changes: 1 addition & 1 deletion _posts/biz/2016-03-01-active-transportation-real-estate.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Protected bike lanes are good for property values
* _Nationally_ (2009): properties in above average walkability or bikability areas worth $34k more

_Source_: [Active Transportation and Real Estate](/images/research/2016-active-transportation-real-estate.pdf), Urban
Land Institute, 2016
Land Institute, 2016
2 changes: 1 addition & 1 deletion _posts/biz/2023-01-01-monon-trail-property-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ tags:
Indiana's Monon Trail is a "rail to trail" conversion that was very good for nearby property values. _Homes within 1/2
mile of the trail sell for on average 11% more_ than those farther away.

_Source_: [Protected bike lanes mean business](/images/research/2023-protected-bike-lanes-mean-business.pdf)
_Source_: [Protected bike lanes mean business](/images/research/2023-protected-bike-lanes-mean-business.pdf)
2 changes: 1 addition & 1 deletion _posts/environment/2014-09-01-pbl-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ dramatically increase ridership. Over a 6 month stretch ...
| Broadway (47th - 59th St) | 108% |
| Columbus Ave | 51% |

_Source_: [NYC Protected Bike Lane Analysis](/images/research/2014-09-nyc-pbl-analysis.pdf), NYC DOT, 2014
_Source_: [NYC Protected Bike Lane Analysis](/images/research/2014-09-nyc-pbl-analysis.pdf), NYC DOT, 2014
2 changes: 1 addition & 1 deletion _posts/environment/2016-10-17-seville-ridership-boom.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ size that's hard to overstate.
On the effect of networks of cycle-tracks on the risk of cycling. The case of Seville, 2016

* [pre-print pdf](/images/research/2016-seville-ridership.pdf)
* [published paper link (paywalled)](https://www.sciencedirect.com/science/article/abs/pii/S0001457517301021?via%3Dihub)
* [published paper link (paywalled)](https://www.sciencedirect.com/science/article/abs/pii/S0001457517301021?via%3Dihub)
2 changes: 1 addition & 1 deletion _posts/news/2012-12-05-citylab-cyclists-spend-more.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Key quote ...

* [pdf](/images/news/2012-citylab-pedestrians-bikes-spending.pdf)

* [orignal link](https://www.bloomberg.com/news/articles/2012-12-05/cyclists-and-pedestrians-can-end-up-spending-more-each-month-than-drivers)
* [orignal link](https://www.bloomberg.com/news/articles/2012-12-05/cyclists-and-pedestrians-can-end-up-spending-more-each-month-than-drivers)
2 changes: 1 addition & 1 deletion _posts/news/2013-09-10-citylab-bike-lanes-retail.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Key quote ...

* [pdf](/images/news/2013-citylab-bikes-biz.pdf)

* [orignal link](https://www.bloomberg.com/news/articles/2013-09-10/no-bike-lanes-don-t-hurt-retail-business)
* [orignal link](https://www.bloomberg.com/news/articles/2013-09-10/no-bike-lanes-don-t-hurt-retail-business)
4 changes: 2 additions & 2 deletions _posts/news/2014-08-14-riding-on-sidewalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ In one case sidewalk riding went down 81% despite bike volume going up 190%.

Key quote ...

> "The reason that cyclists use the sidewalks is that they don't want to die," wrote the District's John Glad.
> "The reason that cyclists use the sidewalks is that they don't want to die," wrote the District's John Glad.
> "If and when they are provided with dedicated bike lanes that are not accessible to drivers, they will be only too
> happy to use them."
#### Source

* [pdf](/images/news/2014-citylab-riding-on-sidewalk.pdf)
* [original link](https://www.bloomberg.com/news/articles/2014-08-14/tired-of-cyclists-riding-on-the-sidewalk-build-more-bike-lanes)
* [original link](https://www.bloomberg.com/news/articles/2014-08-14/tired-of-cyclists-riding-on-the-sidewalk-build-more-bike-lanes)
2 changes: 1 addition & 1 deletion _posts/news/2014-09-08-vox-bike-lane-travel-times.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ protected bike lane design that helped with travel times.
#### Source

* [pdf](/images/news/2014-vox-bike-lane-travel-times.pdf)
* [original link](https://www.vox.com/2014/9/8/6121129/bike-lanes-traffic-new-york)
* [original link](https://www.vox.com/2014/9/8/6121129/bike-lanes-traffic-new-york)
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Key quote ...

* [pdf](/images/news/2015-city-lab-good-for-business.pdf)

* [original link](https://www.bloomberg.com/news/articles/2015-03-13/every-study-ever-conducted-on-the-impact-converting-street-parking-into-bike-lanes-has-on-businesses)
* [original link](https://www.bloomberg.com/news/articles/2015-03-13/every-study-ever-conducted-on-the-impact-converting-street-parking-into-bike-lanes-has-on-businesses)
2 changes: 1 addition & 1 deletion _posts/news/2015-10-06-streetsblog-salt-lake-bike-lanes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Key quote ...

* [pdf](/images/news/2015-streetsblog-slc.pdf)

* [orignal link](https://usa.streetsblog.org/2015/10/06/salt-lake-city-cuts-car-parking-adds-bike-lanes-sees-retail-boost)
* [orignal link](https://usa.streetsblog.org/2015/10/06/salt-lake-city-cuts-car-parking-adds-bike-lanes-sees-retail-boost)
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Separated Bike Lanes Means Safer Streets, Study Says, 2019

* [pdf](/images/news/2019-streetsblog-protect-bike-safety.pdf)

* [orignal link](https://usa.streetsblog.org/2019/05/29/protect-yourself-separated-bike-lanes-means-safer-streets-study-says)
* [orignal link](https://usa.streetsblog.org/2019/05/29/protect-yourself-separated-bike-lanes-means-safer-streets-study-says)
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Includes helpful diagrams on the different types of bike infrastructure.

Note the distinction between designs

* unprotected designs
* sharrows
* bike lanes between parked cars and traffic (door lanes)
* unprotected designs
* sharrows
* bike lanes between parked cars and traffic (door lanes)
* protected designs
* buffered bike lanes
* parking protected lanes
Expand All @@ -58,4 +58,4 @@ Why cities are investing in safer, more-connected cycling infrastructure, Urban

* [pdf](/images/news/2022-urban-inst-cities-invest-in-bikes.pdf)

* [orignal link](https://www.urban.org/urban-wire/why-us-cities-are-investing-safer-more-connected-cycling-infrastructure)
* [orignal link](https://www.urban.org/urban-wire/why-us-cities-are-investing-safer-more-connected-cycling-infrastructure)
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Key quote ...

* [pdf](/images/news/2024-business-insider-bikes-good-for-business.pdf)

* [orignal link](https://www.businessinsider.com/bike-lanes-good-for-business-studies-better-streets-2024-3)
* [orignal link](https://www.businessinsider.com/bike-lanes-good-for-business-studies-better-streets-2024-3)
2 changes: 1 addition & 1 deletion _posts/safety/2010-10-01-nz-bike-injuries-and-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The injury rates per million hours spent traveling by mode of transportation ...
It is suspected that the "safety in numbers" effect went away as mode share switched from bikes to cars. It is noted
that the NZ passed an all age mandatory helmet law in 1994.

_Source_: [Evaluation of New Zealand's bicycle helmet law](/images/research/2010-10-nz-bike-injuries.pdf), 2010
_Source_: [Evaluation of New Zealand's bicycle helmet law](/images/research/2010-10-nz-bike-injuries.pdf), 2010
6 changes: 3 additions & 3 deletions _posts/safety/2011-02-08-nyc-green-paint.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ were released in February 2011.

* cars drive in the bike lane
* 16% of the time when it's unpainted
* 7% of the time when it's painted green
* 7% of the time when it's painted green
* bike lanes are obstructed
* 7% of the time when unpainted
* 4% of the time when painted green
Expand All @@ -28,5 +28,5 @@ design for bike lanes to enhance safety.
* Evaluation of green bicycle lanes to increase compliance and bicycle safety, 2011
* [pdf](/images/research/2011-nyc-green-paint.pdf)
* MUTCD approval (adoption) of green paint for bike lanes
* [pdf](/images/research/mutcd-green-paint.pdf)
* [original link](https://mutcd.fhwa.dot.gov/resources/interim_approval/ia14/)
* [pdf](/images/research/mutcd-green-paint.pdf)
* [original link](https://mutcd.fhwa.dot.gov/resources/interim_approval/ia14/)
2 changes: 1 addition & 1 deletion _posts/safety/2012-02-01-evaluation-nz-bike-helmet-law.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Injury data

![raw injury data pre/post bike helmet law](/images/img/environment/2012-nz-helmet-injury-table.png)

_Source_: [Evaluation of New Zealand's bicycle helmet law](/images/research/2012-02-evaluation-nz-bike-helmet.pdf), 2012
_Source_: [Evaluation of New Zealand's bicycle helmet law](/images/research/2012-02-evaluation-nz-bike-helmet.pdf), 2012
2 changes: 1 addition & 1 deletion _posts/safety/2012-10-01-measuring-street.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Protected bike lanes decreased injuries for _all_ road users.
* 8th Ave: 35% reduction
* 9th Ave: 58% reduction

_Source_: [Measuring the street](assets/research/2012-10-measuring-the-street.pdf), NYC DOT, 2012
_Source_: [Measuring the street](assets/research/2012-10-measuring-the-street.pdf), NYC DOT, 2012
4 changes: 2 additions & 2 deletions _posts/safety/2014-09-01-pbl-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ tags:
- NYC
---

3 years of data from protected bike lane implementations around NYC show reduction of injuries for all road users.
3 years of data from protected bike lane implementations around NYC show reduction of injuries for all road users.
Everyone, drivers and their passengers included, are injured in crashes less often when streets have protected bike
lanes.

![everyone is safer in nyc thanks to pbls](/images/img/2014-09-nyc-pbl/injury-plot.png)

This study also shows that from 2001 to 2013, a 75% reduction in cycling risk.

_Source_: [NYC Protected Bike Lane Analysis](/images/research/2014-09-nyc-pbl-analysis.pdf), NYC DOT, 2014
_Source_: [NYC Protected Bike Lane Analysis](/images/research/2014-09-nyc-pbl-analysis.pdf), NYC DOT, 2014
4 changes: 2 additions & 2 deletions _posts/safety/2016-03-01-fhwa-first-responders.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Converting two-way four lane roads to two travel lanes with center left turn lan
can also _improve emergency response times_. Case studies from Ocean City, NJ and Woodbury, NJ demonstrate this; the
former's road diet also included a buffered bike lane in the design.

Diagram of the minimum road diet considered.
Diagram of the minimum road diet considered.

![4 lanes to 2 with a suicide lane](/images/img/safety/2016-fhwa-first-responder.png)

The post road diet designs make driver behavior more predictable, safer, and with much less speeding. All road users are
better accounted for. These combine to make a more easily navigable street for first responders.
better accounted for. These combine to make a more easily navigable street for first responders.

Key quote ...

Expand Down
4 changes: 2 additions & 2 deletions _posts/safety/2023-09-21-bike-lanes-good-for-pedestrians.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "NYC DOT: Bike lanes are good for pedestrians"
title: "NYC DOT: Bike lanes are good for pedestrians"
categories:
- Safety
tags:
Expand All @@ -13,4 +13,4 @@ pedestrians the decline was 39%!
#### Source

* [pdf](/images/news/2023-nycdot-bike-lanes-pedestrians.pdf)
* [original link](https://www.nyc.gov/html/dot/html/pr2023/east-ny-bike-lanes.shtml)
* [original link](https://www.nyc.gov/html/dot/html/pr2023/east-ny-bike-lanes.shtml)
Loading

0 comments on commit 05b682a

Please sign in to comment.