Skip to content
Merged
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
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# githubpages

Currently supposed to be an example maybe oneday I will make something of this.

Created as an example. Site visible here:
https://arran4.github.io/githubpages/
# githubpages

This repository is a simple example of a Hugo site that can be deployed with GitHub Pages. Treat it as a template to build your own site. The live example is available at <https://arran4.github.io/githubpages/>.


## Requirements

- [Hugo](https://gohugo.io/) static site generator must be installed. On Ubuntu
you can install it with `apt-get install hugo` or download a binary from the
[Hugo releases page](https://github.com/gohugoio/hugo/releases).

## Running the site locally

Run the following command in the repository root to start a development server:

```bash
hugo server
```

The site will be served at <http://localhost:1313> by default.

## Repository structure

- `content/` – Markdown files that make up the site content.
- `themes/` – Custom themes used by the site.
- `archetypes/` – Templates for new content.
- `config.toml` – Main configuration file.

Feel free to fork this repository as a starting template for your own Hugo + GitHub Pages site.