Skip to content

Commit a05bbfc

Browse files
committed
Clean up the README
1 parent 9c2ff03 commit a05bbfc

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Genja is a simple static website generator. It is a Python command line tool tha
55
Installation
66
------------
77

8-
Install uv using the installation steps at https://docs.astral.sh/uv. After installing uv, use the `uv tool` command to install Genja as a command line tool on your computer:
8+
Install uv by following the installation steps at https://docs.astral.sh/uv. After installing uv, use the `uv tool` command to install Genja as a command line tool on your computer:
99

1010
```bash
1111
uv tool install genja
@@ -19,7 +19,7 @@ genja --version
1919

2020
## Usage
2121

22-
Before running Genja, create a project structure as shown below. Markdown files go into the `_pages` and `_posts` directories. The pages directory is for standalone content that is not dated such as an about page or contact page. The posts directory is for dated content such as blog posts or articles. The `_templates` directory contains [Jinja](https://jinja.palletsprojects.com/) templates that are used to render the HTML pages. The `mysite` directory contains the generated website which can be hosted with GitHub Pages or some other web hosting platform. Lastly, the `genja.toml` file defines the URLs and directories for the project.
22+
Before running Genja, create a project structure as shown below. Markdown files go into the `_pages` and `_posts` directories. The pages directory is for standalone content that is not dated such as an about page or contact page. The posts directory is for dated content such as blog posts or articles. The `_templates` directory contains [Jinja](https://jinja.palletsprojects.com/) templates that are used to render the HTML pages. The `mysite` directory contains the generated website which can be hosted with GitHub Pages or some other web hosting platform. This directory can be named anything but it must be defined in the `genja.toml` configuration file using the `site_output` variable. The `genja.toml` file defines the URLs and directories for the project.
2323

2424
```text
2525
myproject/
@@ -39,7 +39,7 @@ myproject/
3939
└── genja.toml
4040
```
4141

42-
The items in the `genja.toml` file are shown below. The ``base_url`` is the URL for the homepage of the website. The ``posts_output`` defines the output directory for the generated posts. The HTML files generated from Genja are located in the ``site_output`` directory. Static content such as images and CSS files should go in this directory. The title of the website is defined by the ``title`` key.
42+
The items in the `genja.toml` file are shown below. The `base_url` is the URL for the homepage of the website. The `posts_output` defines the output directory for the generated posts. The HTML files generated from Genja are located in the `site_output` directory. Static content such as images and CSS files should go in this directory. The title of the website is defined by the `title` key.
4343

4444
```toml
4545
base_url = "https://example.com"
@@ -74,4 +74,4 @@ Support this project by using the **:heart: Sponsor** button at the top of this
7474

7575
## License
7676

77-
This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE.md) document for the license text.
77+
This project is licensed under the terms of the MIT license. See the [LICENSE.md](LICENSE.md) document for the license text.

0 commit comments

Comments
 (0)