Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
agaetep committed Aug 29, 2024
1 parent 1334f85 commit a177a9f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,28 @@ there is a CSS tag, ``#blog`` that mimics the header image:

To include a blog post on the front page's carousel, add it to the [carousel.yaml](/data/carousel.yaml) file.

Dependencies
------------

The search feature is implemented using [Pagefind](https://pagefind.app/) and can be installed with `npx` or by [downloading the binary](https://pagefind.app/docs/installation/#downloading-a-precompiled-binary).

Development
-----------

To compile and host the site under development on port 1313, use:

```
$ hugo server
```

Pagefind sources from the `public/` directory hugo compiles when the website is built. To view the website with full functionality:

First compile it:
```
$ hugo
```

Then run it using pagefind:
```
$ ./pagefind --site public --serve
```

0 comments on commit a177a9f

Please sign in to comment.