81 lines
3.6 KiB
Markdown
81 lines
3.6 KiB
Markdown
# Heavy modifications have been made to this theme, please refer to the original repo for the agnes hugo theme https://github.com/dchucks/agnes-hugo-theme
|
|
|
|
## Agnes
|
|
<p>
|
|
<a href="https://app.netlify.com/sites/agnes-hugo-sample-site/deploys">
|
|
<img alt="Netlify Status" src="https://api.netlify.com/api/v1/badges/a85b2422-de3b-4e3b-a2d8-79acd2076648/deploy-status">
|
|
</a>
|
|
<a href="https://github.com/dchucks/agnes-hugo-theme/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/badge/license-GPL_3.0-green">
|
|
</a>
|
|
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fdchucks%2Fagnes-hugo-theme?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdchucks%2Fagnes-hugo-theme.svg?type=shield&issueType=license"/></a>
|
|
</p>
|
|
|
|
Agnes is a landing page Hugo theme ported from the free HTML template designed by Cruip, a marketplace of <a href="https://cruip.com/">Tailwind CSS templates</a>. The design is lovely and features an intro screenshot preview, a product/service list, and a three-tier pricing table.
|
|
|
|
Check out the [**sample site**](https://agnes-hugo-sample-site.netlify.app/).
|
|
|
|
<p><img src="https://raw.githubusercontent.com/dchucks/agnes-hugo-theme/master/images/screenshot.jpg" alt="Agnes Screenshot for example site" align="center" width="600" height="auto"></p>
|
|
|
|
# Getting started
|
|
We are assuming that you have already installed Hugo on your computer [follow the Quick start guide](https://gohugo.io/getting-started/quick-start/) if not.
|
|
|
|
## Create your Hugo website
|
|
```
|
|
hugo new site my_website
|
|
cd my_website
|
|
```
|
|
|
|
## Adding theme to your website
|
|
There are two ways to add the theme to your Hugo website.
|
|
|
|
### Method 1: Without involving Git (Easier)
|
|
* Download the Agnes theme as a Zip file from https://github.com/dchucks/agnes-hugo-theme/archive/refs/heads/main.zip
|
|
* Create a sub-folder "Agnes" under the "Themes" folder.
|
|
```
|
|
cd themes
|
|
mkdir Agnes
|
|
```
|
|
* Unzip the zip file and copy all the files and folders (from the folder where the README.md file resides) to the Agnes folder.
|
|
* Now test if the theme is working, as follows, and your site should be running at http://localhost:1313/
|
|
```
|
|
cd Agnes/exampleSite/*
|
|
hugo server --themesDir ../..
|
|
```
|
|
|
|
### Method 2: With Git (needs Git knowledge)
|
|
* Clone the theme repository
|
|
```
|
|
git clone https://github.com/dchucks/agnes-hugo-theme.git Agnes
|
|
```
|
|
* Copy the example site
|
|
```
|
|
cp -r Agnes/* my_website/themes
|
|
```
|
|
* Navigate to your website, and initialize an empty Git repository in the directory.
|
|
```
|
|
cd my_website
|
|
git init
|
|
```
|
|
* Add Agnes theme as a submodule and update the site configuration file for the current theme.
|
|
```
|
|
git submodule add -f https://github.com/dchucks/agnes-hugo-theme.git ./themes/Agnes
|
|
echo "theme = 'Agnes'" >> hugo.toml
|
|
```
|
|
* Start the dev server, your site should be running at http://localhost:1313/
|
|
```
|
|
hugo server
|
|
```
|
|
|
|
### Example config.toml
|
|
An example site [Config file](https://github.com/dchucks/agnes-hugo-theme/blob/main/exampleSite/config.toml) can be found under the theme's `exampleSite` folder. Just update the content in the file relevent to your website and you should be done.
|
|
|
|
## Contributing
|
|
If you want to contribute to Agnes to add a feature or improve the code, please open an [issue](https://github.com/dchucks/agnes-hugo-theme/issues) or make a [pull request](https://github.com/dchucks/agnes-hugo-theme/pulls).
|
|
|
|
## Show your support
|
|
Please give a :star: if this project helped you!
|
|
<p><a href="https://ko-fi.com/debashish"><img src="https://storage.ko-fi.com/cdn/cup-border.png" alt="Buy Me a Coffee!" align="center" width="75px" height="auto"> Buy me a Coffee ;)</a></p>
|
|
|
|
## License
|
|
GPL-3.0 © [Debashish Chakrabarty](https://www.debashish.com)
|