Skip to content

Update spacing #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lovelydinosaur merged 1 commit into from
Feb 13, 2026
Merged

Update spacing #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ MkDocs is a smart, simple, website design tool.

![MkDocs](docs/img/mkdocs.png)

<br/>

## Installation

Install the `mkdocs` command line tool...
Expand All @@ -22,6 +24,8 @@ $ pip install git+https://github.com/encode/mkdocs.git

*MkDocs supports [GitHub Flavored Markdown](docs/writing.md) for page authoring.*

<br/>

## Writing your docs

1. Create additional markdown pages.
Expand Down Expand Up @@ -49,6 +53,8 @@ favicon = "📘"

*Use either [`README.md` or `index.md`](docs/navigation.md#url-structure) for the homepage.*

<br/>

## Custom styling

Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.
Expand All @@ -59,6 +65,8 @@ Styling adaptations can be kept simple, such as customising the colour scheme, o

Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.

<br/>

![Kelp](docs/img/kelp.png)

*The MkDocs documentation, served with the Kelp theme.*