Skip to content

Add footnote that abridge is included as submodule #11

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
merged 4 commits into from
Jan 8, 2025
Merged

Add footnote that abridge is included as submodule #11

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ad9cad
Add footnote that abridge is included as submodule
philderbeast Jan 4, 2025
afc183b
Add command sequence to get started
philderbeast Jan 8, 2025
f6e2d28
Link to git submodule help
philderbeast Jan 8, 2025
781bee9
The latest git-clone docs mention --recurse-submodules
philderbeast Jan 8, 2025
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,20 @@

## Local installation

The blog is made with [Zola], based on the [Abridge theme].
The blog is made with [Zola] and based on the [Abridge theme] that is included
as a Git [submodule][git-submodule].

You will need:
* The `zola` binary v0.19.1 or higher

Run `zola serve` in order to serve the website and automatically render it when files change.

```
$ git clone [email protected]:haskell/blog.haskell.org.git --recurse-submodules
$ cd blog.haskell.org
$ zola serve
```

## Contribute content

### Blog post structure
Expand Down Expand Up @@ -60,3 +67,4 @@ documentation-best-practices

[Zola]: https://www.getzola.org/
[Abridge theme]: https://abridge.pages.dev/overview-abridge/
[git-submodule]: https://git-scm.com/docs/git-submodule
Loading