Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
kkeles committed Jan 12, 2024
1 parent 6e1a364 commit 6726a08
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
![AWS User Groups Logo](./static/images/uglogo.png)
# Website Template for AWS User Groups

## Introduction
Expand Down Expand Up @@ -25,8 +26,33 @@ visit [AWS UG Berlin website](https://aws-user-group.berlin/) to examine the lat
* Accept additional partial requests

## Installation
### Prerequisites
* [Hugo](https://gohugo.io/installation/)
* any IDE: [*](https://www.jetbrains.com/webstorm/download) [*](https://code.visualstudio.com/download) [*](https://www.vim.org/download.php) [*](https://atom-editor.cc/)
* [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

## Usage
### Configuration
*Please ignore theme.toml as it's related to this project but can remain as is for your website.*
<br>**hugo.toml** is your main configuration file:
`<br>- baseURL: main domain you use for your website ('https://example.com').
- languageCode: to define the language(s) of your website. Use ISO 639-1 convention ('en-us','de-at').
<br>- title: title of your website ('AWS User Group Brussels')
<br>- theme = "awsug" *please keep it as is*
<br>- summaryLength: number of words to appear in blog summary ('35').`

<br> [menu]: define menu elements for navigation. [[menu.main]] refers to a particular menu element used, main is the identifier of the menu. In future, you can create [[menu.mobile]] or [[menu.french]] for example.
<br> [[menu.main]]
identifier = "about"
name = "About"
url = "/about/"
weight = 20

## Configuration

## License
This project is licensed under the terms of the GNU General Public License. For additional details, see the LICENSE file included.
Binary file added static/images/uglogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6726a08

Please sign in to comment.