Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

WIP: Use static site generator #1

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
public/
45 changes: 42 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,43 @@
huntsearch.org
==============
# Homepage for the Hunt framework

homepage for hunt framework
Hunt is a fast, flexible and lightweight search platform written in
Haskell. This repository provides the source of the documentation,
packaged up as a homepage, where you can learn all about it.


## Setting up

This homepage is written with the popular static site generator named
[Hugo][1]. As such, if you want to help out with this documentation,
first you need to [install][2] Hugo.

Then follow these steps and fire up your favorite editor to edit or
style this site.

```bash
$ git clone https://github.com/hunt-framework/huntsearch.org
$ cd huntsearch.org/
$ hugo server -D
```


## Organization

This repository is roughly organized around the following directories.

- *content* contains the actual content of the documentation. This is
were you would change typos or improve the content.
- *static* contains all static files, like javascript, stylesheets or
images.
- *layouts* contains all files, which define, *how* the files from the
content directory should be rendered to HTML. It's powered by the
built-in templating language from the Go programming language. You
can read more about the layouts directory in Hugos documentation
[here][3].

That should provide you with enough information to get started helping
out! Happy documenting.

[1]: https://gohugo.io/
[2]: https://gohugo.io/getting-started/installing/
[3]: https://gohugo.io/templates/
3 changes: 0 additions & 3 deletions blog.html

This file was deleted.

304 changes: 0 additions & 304 deletions chapters/Adding_Functionality.md

This file was deleted.

153 changes: 0 additions & 153 deletions chapters/Configuration.md

This file was deleted.

Loading