Skip to content

Commit

Permalink
Simplified README
Browse files Browse the repository at this point in the history
  • Loading branch information
MartenBE committed Jun 17, 2024
1 parent ae85323 commit 11745a4
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ MkDocs allows you to start up a live preview, so you can instantly see how your
mkdocs serve
```
---
<details>
<summary>Configuration</summary>
## Configuration
:bulb: **You don't have to change these files or settings** if you want to keep things simple. In that case, just ignore this section.
Expand All @@ -67,8 +73,18 @@ You can add them to [mkdocs.yml](./mkdocs.yml) .

You can add additional functionality using [MkDocs plugins](https://github.com/mkdocs/catalog). These can be enabled by editing [mkdocs.yml](./mkdocs.yml) . E.g., the [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) plugin for showing the timestamp of the last edit is added in this repo as an example on how to do it.

</details>

---

<details>

<summary>Additional tools</summary>

## Additional tools

:bulb: **You don't need this** if you want to keep things simple. In that case, just ignore this section. Otherwise, it's here if you want an example.

### Automatic deployment

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.
Expand Down Expand Up @@ -98,3 +114,5 @@ 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 11745a4

Please sign in to comment.