Combine start, install, and run readme sections

master
Will Faught 2 years ago
parent c682778f3b
commit 66c2ea9d6d

@ -73,7 +73,7 @@ please share it by [posting code or screenshots](https://github.com/willfaught/p
If you deploy a site, If you deploy a site,
please share it by [posting a link](https://github.com/willfaught/paige/discussions/12). please share it by [posting a link](https://github.com/willfaught/paige/discussions/12).
## Get started with Hugo ## Setup
1. [Install Hugo](https://gohugo.io/installation/) (the extended version is required). 1. [Install Hugo](https://gohugo.io/installation/) (the extended version is required).
@ -125,14 +125,10 @@ please share it by [posting a link](https://github.com/willfaught/paige/discussi
```sh ```sh
$ cd yourproject $ cd yourproject
$ hugo new my-post.md $ hugo new yourpost.md
``` ```
See [Hugo's quick start guide](https://gohugo.io/getting-started/quick-start/) for more information. 5. Install the Paige module:
## Install
Install:
```sh ```sh
$ cd yourproject $ cd yourproject
@ -140,28 +136,25 @@ $ hugo mod init github.com/youraccount/yourproject
$ hugo mod get github.com/willfaught/paige $ hugo mod get github.com/willfaught/paige
``` ```
Update: 6. Import the Paige module:
```sh ```sh
$ cd yourproject $ cd yourproject
$ hugo mod get -u $ cat >>config.toml <<EOF
``` [[module.imports]]
path = "github.com/willfaught/paige"
Example `config.yaml`: EOF
```yaml
module:
imports:
- path: "github.com/willfaught/paige"
``` ```
## Run 7. Build and run the site:
```sh ```sh
$ cd yourproject $ cd yourproject
$ hugo server -D $ hugo server -D
``` ```
See [Hugo's quick start guide](https://gohugo.io/getting-started/quick-start/) for more information.
## Configure ## Configure
There is a single parameter object with sensible defaults that can be overridden in site or page parameters: There is a single parameter object with sensible defaults that can be overridden in site or page parameters:

Loading…
Cancel
Save