Skip to content

Commit

Permalink
Simplified setup
Browse files Browse the repository at this point in the history
  • Loading branch information
MartenBE committed Sep 4, 2024
1 parent f394ba8 commit 14fc806
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 39 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ permissions:
pages: write
id-token: write

jobs:
deploy:
environment:
name: github-pages
Expand Down
40 changes: 1 addition & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,6 @@ You can see the slides of this repository at https://hogenttin.github.io/hogent-

## Table of Contents

- [Basic usage](#basic-usage)
- [Installation](#installation)
- [How do I use this?](#how-do-i-use-this)
- [Live preview](#live-preview)
- [Configuration](#configuration)
- [Theme](#theme)
- [MkDocs options](#mkdocs-options)
- [MkDocs plugins](#mkdocs-plugins)
- [Additional tools](#additional-tools)
- [Automatic deployment](#automatic-deployment)
- [Formatting](#formatting)
- [Linting](#linting)

## Basic usage

### Installation
Expand Down Expand Up @@ -89,30 +76,5 @@ You can add additional functionality using [MkDocs plugins](https://github.com/m

This repo automatically builds the website and pushes them to https://hogenttin.github.io/hogent-mkdocs/ whenever a commit is pushed to the `main` branch. This is done using using [GitHub actions](https://docs.github.com/en/actions) . You can find the workflow in the [.github](./.github) folder.

### Formatting

An [editorconfig](https://editorconfig.org/) config has been added in [.editorconfig](./.editorconfig), which works nicely together with [prettier](https://prettier.io/docs/en/):

```bash
prettier --write "**/*.{md,yml,yaml}"
```

:warning: Use 4 spaces for indentation of nested lists. Otherwise the nesting may not work. This is consistent with the [original MarkDown](https://daringfireball.net/projects/markdown/syntax#list) and the [CommonMark](https://spec.commonmark.org/0.31.2/#lists) specs.

### Linting

A [markdownlint](https://github.com/DavidAnson/markdownlint) config has been added in [.markdownlint-cli2.yaml](./.markdownlint-cli2.yaml):

```bash
markdownlint-cli2 "**/*.md"
```

A [yamllint](https://yamllint.readthedocs.io/en/stable/index.html) config has been added in [.yamllint.yaml](./.yamllint.yaml):

```bash
yamllint .
```

You can also use the [pre-commit](https://pre-commit.com/) hooks in [.pre-commit-config.yaml](./.pre-commit-config.yaml) to automatically check this at every local commit.

</details>

0 comments on commit 14fc806

Please sign in to comment.