Skip to content

Commit bbcb512

Browse files
authored
Merge pull request #9 from arran4/codex/update-readme.md-with-requirements-and-setup
Improve README for local usage
2 parents 40633f8 + 3502d7b commit bbcb512

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1-
# githubpages
2-
3-
Currently supposed to be an example maybe oneday I will make something of this.
4-
5-
Created as an example. Site visible here:
6-
https://arran4.github.io/githubpages/
1+
# githubpages
2+
3+
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/>.
4+
5+
6+
## Requirements
7+
8+
- [Hugo](https://gohugo.io/) static site generator must be installed. On Ubuntu
9+
you can install it with `apt-get install hugo` or download a binary from the
10+
[Hugo releases page](https://github.com/gohugoio/hugo/releases).
11+
12+
## Running the site locally
13+
14+
Run the following command in the repository root to start a development server:
15+
16+
```bash
17+
hugo server
18+
```
19+
20+
The site will be served at <http://localhost:1313> by default.
21+
22+
## Repository structure
23+
24+
- `content/` – Markdown files that make up the site content.
25+
- `themes/` – Custom themes used by the site.
26+
- `archetypes/` – Templates for new content.
27+
- `config.toml` – Main configuration file.
728

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

0 commit comments

Comments
 (0)