Skip to content

Commit

Permalink
chore(docs): clean up a little
Browse files Browse the repository at this point in the history
  • Loading branch information
isabellabrookes committed Jul 8, 2024
1 parent 70e7ac8 commit fd2753b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# TWC The Netherlands

[![Netlify Status][netlify_bagde]][netlify_url]
[![website][website_badge]][website_url]
[![production][production_badge]][production_url]
[![Code style][code_style_badge]][code_style_url]
[![Twitter: nederlandtwc][twitter_badge]][twitter_url]

[![website][website_badge]][website_url]
[![production][production_badge]][production_url]
[![i18n-en][i18n_en_badge]][i18n_en_url]
[![i18n-nl][i18n_nl_badge]][i18n_nl_url]

> This repository is responsible for most content visible on the website [techwerkers.nl](https://techwerkers.nl). The site is made with a static site generator called [Jekyll](https://jekyllrb.com/) in a language called Ruby.
## Install
## 🛠️ Installation

Read the [installation guide](./docs/contributing.md) to get set up.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing
# 🤝 Contributing

## Add an event

Expand Down
5 changes: 3 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Installation
# 🛠️ Installation

## Formatting

Install prettier and precommit hooks: `npm install`

You can manually run prettier using: `npx prettier . --write`

### Skip pre-commit hooks

1. To skip pre-commit hooks, use `git commit --no-verify` or `git commit -n`
1. Alternatively, you could not run `npm install`; opting to install prettier and the plugin globally `npm install -g prettier @shopify/prettier-plugin-liquid``
1. Alternatively, you could not run `npm install`; opting to install prettier and the plugin globally via `npm install -g prettier @shopify/prettier-plugin-liquid`

## With Docker (recommended)

Expand Down

0 comments on commit fd2753b

Please sign in to comment.