Skip to content

Commit cd62e64

Browse files
Merge pull request #26 from MariaBHaque/lemon-edits
Improve README formatting, links, and structure
2 parents d563873 + 56dc4fb commit cd62e64

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
# Lemonium website
22

3-
Promoting [website] for foundation Lemon's Resting Area. Build with the Hugo static site generator.
3+
This repository contains the source code for [Lemon's Resting Area](https://lemon73-computing.github.io), a website built using [Hugo](https://gohugo.io/), a fast and flexible static site generator. The site supports both Japanese and English content.
44

5-
[website]: https://lemon73-computing.github.io "Lemon's Resting Area - Website"
5+
## Table of Contents
6+
- [How to use](#how-to-use)
7+
- [Create a New Article](#create-new-article)
8+
- [More Information](#more-information)
9+
- [About Multilingual Archetypes](#about-multilingual-archetypes)
10+
- [License](#license)
611

7-
## How to use
12+
## How to Use
813

9-
### Building and testing the site locally
14+
### Building and Testing the Site Locally
1015

1116
Here are the steps to build site on Ubuntu-based system (tested on KDE neon 24.04):
1217

1318
```shell
14-
# intall golang
19+
# install golang
1520
sudo apt install golang
1621

1722
# install latest version of Hugo (the example uses v0.128.0)
@@ -24,7 +29,7 @@ hugo server
2429
# http://localhost:1313
2530
```
2631

27-
### Create new article
32+
## Create New Article
2833

2934
To create an article using [the default archetype](./archetypes/default.md):
3035
```shell
@@ -35,7 +40,7 @@ hugo new content posts/2024/something.md
3540
hugo new content/en/posts/2024/something.md
3641
```
3742

38-
To create an article using [the release note arthetype](./archetypes/releasenote.md):
43+
To create an article using [the release note archetype](./archetypes/releasenote.md):
3944
```shell
4045
# Japanese
4146
hugo new content -k releasenote posts/2024/something.md
@@ -44,9 +49,13 @@ hugo new content -k releasenote posts/2024/something.md
4449
hugo new -k releasenote content/en/posts/2024/something.md
4550
```
4651

47-
More information: https://gohugo.io/content-management/archetypes
52+
## More Information
4853

49-
(About multilingual archetypes: https://discourse.gohugo.io/t/multilingual-archetypes/39542/8)
54+
https://gohugo.io/content-management/archetypes
55+
56+
## About multilingual archetypes
57+
58+
https://discourse.gohugo.io/t/multilingual-archetypes/39542/8)
5059

5160
## License
5261

0 commit comments

Comments
 (0)