Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/hivickylai/hugo-theme-sam.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictoria Drake <24644237+victoriadrake@users.noreply.github.com>2022-04-30 18:08:24 +0300
committerGitHub <noreply@github.com>2022-04-30 18:08:24 +0300
commit248b48be1fb01e8b07f089faf0385ec5f2f7fce2 (patch)
tree36fedd6fb0640ee186b3f83b0b099e010bd817b0
parent4728f3064e62499bfd099584fa94a8a426d24481 (diff)
Update README
-rw-r--r--README.md43
1 files changed, 20 insertions, 23 deletions
diff --git a/README.md b/README.md
index 20b4428..3bcebc2 100644
--- a/README.md
+++ b/README.md
@@ -30,8 +30,6 @@ Focused on content and typography, the stylized index page is really just a list
## Requirements
-### General
-
Requires the **extended** version of Hugo. You can find [installation instructions here](https://gohugo.io/getting-started/installing/) (latest version recommended). Here's a handy [Bash function for downloading a specific Hugo version](https://victoria.dev/blog/how-to-do-twice-as-much-with-half-the-keystrokes-using-.bashrc/#bash-function-for-downloading-extended-hugo).
Extended Hugo's [PostCSS](https://gohugo.io/hugo-pipes/postcss/) requires JavaScript packages to compile the styles for this theme. If you're seeing an error like this:
@@ -55,27 +53,25 @@ cd exampleSite/
npm i postcss postcss-cli autoprefixer
```
-### Only when using theme as hugo module:
-
-Go language needs to be installed (version >= 1.12), download Go installer [here](https://go.dev/dl/)
-
## 1. Get the theme
-### Route 1 (recommended): use theme as hugo module
+### Use the theme as hugo module
-Turn your new or existing site into a hugo module by issuing this command from site root:
+1. Ensure that Go is installed (version >= 1.12). Download the Go installer [here](https://go.dev/dl/).
-```sh
-hugo mod init github.com/me/my-sam-based-site
-```
+2. Turn your new or existing site into a hugo module by issuing this command from site root:
-- Declare the `sam` theme module as a dependency of your site:
+ ```sh
+ hugo mod init github.com/me/my-sam-based-site
+ ```
-```
-hugo mod get github.com/victoriadrake/hugo-theme-sam
-```
+3. Declare the `sam` theme module as a dependency of your site:
-### Route 2 (traditional): install theme locally (git clone or submodule)
+ ```sh
+ hugo mod get github.com/victoriadrake/hugo-theme-sam
+ ```
+
+### Use the theme locally with git clone or as a submodule
Run from the root of your Hugo site:
@@ -93,18 +89,19 @@ git submodule add https://github.com/victoriadrake/hugo-theme-sam.git themes/sam
From the exampleSite, copy `config.toml` to the root folder of your Hugo site. Inside this file, identify the `theme = ...` line.
-### Route 1 (hugo module)
+#### To configure as a Hugo module
Make sure the following line is uncommented in order to activate your theme as hugo module:
-```
+```toml
theme = "github.com/victoriadrake/hugo-theme-sam"
```
-### Route 2 (theme cloned locally)
-Make sure the following line is uncommented in order to activate your theme as hugo module:
+#### To configure a local theme
-```
+Make sure the following line is uncommented:
+
+```toml
theme = "sam"
```
@@ -251,11 +248,11 @@ If you have a question or get stuck, please [open an issue](https://github.com/v
Pull requests for bug fixes and enhancements are welcome! Please ensure you first read about [contributing](CONTRIBUTING.md) to this project.
-Open source themes like this one would not be possible without some amazing __[contributors](https://github.com/victoriadrake/hugo-theme-sam/graphs/contributors)__. Thank you!
+Open source themes like this one would not be possible without some amazing **[contributors](https://github.com/victoriadrake/hugo-theme-sam/graphs/contributors).** Thank you!
## License
-Copyright (C) 2018-2021 [Victoria Drake](https://victoria.dev/)
+Copyright (C) 2018-2022 [Victoria Drake](https://victoria.dev/)
Licensed under the [Apache License, Version 2.0](https://github.com/victoriadrake/hugo-theme-sam/blob/master/LICENSE) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).