Skip to content

Commit

Permalink
feat: rearrange structure (#5)
Browse files Browse the repository at this point in the history
* feat: reorganize to match theme structure with exampleSite

* feat: reorganize to match theme structure with exampleSite

* docs: adapted quickstart instructions

* docs(readme): new hugo server cmd!
  • Loading branch information
mavogel authored Jan 30, 2024
1 parent 45d0f46 commit 4c99eab
Show file tree
Hide file tree
Showing 156 changed files with 26 additions and 68 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![AWS User Groups Logo](./static/images/uglogo.png)
![AWS User Groups Logo](./img/uglogo.png)
# Website Template for AWS User Groups

## Introduction
Expand All @@ -14,6 +14,7 @@ visit [AWS UG Berlin website](https://aws-user-group.berlin/) to examine the lat
| Kadir Keles | October 2023 |
| Aaron Walker | December 2023 |
| Jacob Moracha | January 2024 |
| Manuel Vogel | January 2024 |

*Want to contribute? Mail us with a short introduction:* [email protected]

Expand All @@ -32,9 +33,29 @@ visit [AWS UG Berlin website](https://aws-user-group.berlin/) to examine the lat
* [git](https://git-scm.com/downloads)

### Quick Start
* clone the project to your local device: `git clone https://github.com/kkeles/awsug-hugo`
* navigate to project folder in your terminal. Test by running: `hugo server` - visit `localhost:1313` in your web browser. You should see the website up & running
* You can also use `hugo server` for development. Change content, edit templates and layout in /themes/awsug folder and follow the updates at localhost:1313
For User Groups which want to use the template as well (adapted from the official [hugo quickstart](https://gohugo.io/getting-started/quick-start/#commands))

* Get the theme and use it
```bash
hugo new site awsug-your-town
cd awsug-your-town
git init
git submodule add https://github.com/kkeles/awsug-hugo.git themes/awsug
```
* preview the example site
```bash
# Note '--themesDir' is relative to the directory defined by --source
hugo server --source themes/awsug/exampleSite --themesDir ../..
```
* Then visit `localhost:1313` in your browser, to see the site, which is the them from Berlin AWS UG :tada:
* If your happy use it as a baseline
```bash
# copy the whole exampleSite
cp -r themes/awsug/exampleSite/* .
hugo server
```

Visit `localhost:1313` in your browser again, start adapting and enjoy the hot-reloading.

## Usage
### Configuration & Menu Items
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions exampleSite/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
resources/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file added exampleSite/layouts/.gitkeep
Empty file.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 0 additions & 15 deletions themes/awsug/LICENSE

This file was deleted.

10 changes: 0 additions & 10 deletions themes/awsug/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions themes/awsug/archetypes/default.md

This file was deleted.

35 changes: 0 additions & 35 deletions themes/awsug/hugo.toml

This file was deleted.

0 comments on commit 4c99eab

Please sign in to comment.