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

github.com/cristianmarint/sicily-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCristian Marín <cristianmarint@gmail.com>2020-10-09 18:54:29 +0300
committerCristian Marín <cristianmarint@gmail.com>2020-10-09 18:54:29 +0300
commit2c3df69134484cc6afc145753f240295cf09608c (patch)
tree5d54ceb8e36d96fa746f96bc7e4d3a6029c85b95
parent1590c0836d9bc2c740184db17f05564d4368f9d4 (diff)
🧾 Making README.md better
-rw-r--r--README.md136
1 files changed, 108 insertions, 28 deletions
diff --git a/README.md b/README.md
index 605e425..035e566 100644
--- a/README.md
+++ b/README.md
@@ -1,84 +1,164 @@
+
# Easy Setup (Hugo + Netlify + Forestry)
+
Build your website with sicily theme by following this easy steps (No Coding Required)
-<a href="http://bit.ly/meghna-hugo-installation" target="_blank" title="meghna hugo installation" rel="nofollow"><img width="100%" src="https://user-images.githubusercontent.com/37659754/70844354-4028be00-1e6a-11ea-8d84-02e9a25e7db8.png"></a>
+
+
+<a href="http://bit.ly/meghna-hugo-installation" target="_blank" title="meghna hugo installation" rel="nofollow"><img width="100%" src="https://user-images.githubusercontent.com/37659754/70844354-4028be00-1e6a-11ea-8d84-02e9a25e7db8.png"></a>
+
+
+
+
+## Table of Contents
+
+
+
+- [Demo](#demo)
+
+- [Quick Start](#quick-start)
+
+- [Installation](#installation)
+
+- [Reporting Issues](#reporting-issues)
+
+- [Technical Support or Questions](#technical-support-or-questions)
+
+- [Licensing](#licensing)
+- [Need some specific?](https://www.cristianmarint.com/contacto.html)
+
+
### What you need !!
-1. Git acccount (Ex: Github, Gitlab etc ) . In our case we use github.
-2. [Netlify](https://bit.ly/netlify-account) account to host files and add custom domain .
-3. [Forestry](https://bit.ly/forestry-account) account to maintain whole project without code.
+
+
+1. Git account (Ex: Github, Gitlab etc ) . In our case we use github.
+
+2. [Netlify](https://bit.ly/netlify-account) account to host files and add custom domain .
+
+3. [Forestry](https://bit.ly/forestry-account) account to maintain whole project without code.
+
+
### Step 1 : Fork or Clone repository
+
+
First we will fork this [sicily](https://github.com/cristianmarint/sicily-hugo-theme) template.
+
+
### Step 2 : Add your repository in Forestry
-Go to your [forestry](https://bit.ly/forestry-account) account and click on `import your site now`. declare your config.toml file [`exampleSite`] and fill up basic settings .
+
+
+Go to your [forestry](https://bit.ly/forestry-account) account and click on `import your site now`. declare your config.toml file [`exampleSite`] and fill up basic settings .
-**Or just click this button for one click installation** [![import to forestry](https://assets.forestry.io/import-to-forestryK.svg)](https://app.forestry.io/quick-start?repo=cristianmarint/sicily-hugo-theme&engine=hugo&version=0.60.1&config=exampleSite)
+
+
+**Or just click this button for one click installation** [![import to forestry](https://assets.forestry.io/import-to-forestryK.svg)](https://app.forestry.io/quick-start?repo=cristianmarint/sicily-hugo-theme&engine=hugo&version=0.60.1&config=exampleSite)
+
+
Now mark everything as done, then go to configuration to change the base url . You can put any url but this have to similar as netlify . So for now put a name which you are going to put in netlify as netlify subdomain.
+
+
### Step 3 : Setup and host website with Netlify
-Here comes the last step . Go to your [netlify](https://bit.ly/netlify-account) account and click add new site . Choose your git repository to import your website in netlify . And now you can see the forked `sicily` theme. select it and follow the steps. Then go to `site settings` for change the site name and put your subdoamin name here what you puted on forestry as base url. save it and go to `deploy` from top menu, Wait a while and click on `site preview` or just simply go to the subdomain you puted as base url. **BOOM! Your site is live.** Now you can go to forestry and add, remove or customize every setting and content.
+
-> If you face any issue regarding the installation feel free to onen [open a new issue](https://github.com/cristianmarint/sicily-hugo-theme/issues)
+Here comes the last step . Go to your [netlify](https://bit.ly/netlify-account) account and click add new site . Choose your git repository to import your website in netlify . And now you can see the forked `sicily` theme. select it and follow the steps. Then go to `site settings` for change the site name and put your subdomain name here what you puted on forestry as base url. save it and go to `deploy` from top menu, Wait a while and click on `site preview` or just simply go to the subdomain you puted as base url. **BOOM! Your site is live.** Now you can go to forestry and add, remove or customize every setting and content.
+
-## Table of Contents
+> If you face any issue regarding the installation feel free to onen [open a new issue](https://github.com/cristianmarint/sicily-hugo-theme/issues)
-- [Demo](#demo)
-- [Quick Start](#quick-start)
-- [Installation](#installation)
-- [Reporting Issues](#reporting-issues)
-- [Technical Support or Questions](#technical-support-or-questions-(paid))
-- [Licensing](#licensing)
-- [More Hugo Themes](https://cristianmarint.com/hugo-themes/)
+
+
## Demo
+
+
[Live Preview](https://sicily-hugo-theme.netlify.app/).
+
+
## Quick Start
+
Quick start options:
+
+
- Clone the repo: `git clone https://github.com/cristianmarint/sicily-hugo-theme.git`.
-- [Download from Github](https://github.com/cristianmarint/sicily-hugo-theme/archive/master.zip).
+
+- [Download from Github](https://github.com/cristianmarint/sicily-hugo-theme/archive/master.zip).
+
+
## Installation
+
At the top we have shown an easy hugo installation. but still if you think you want to go with the traditional way then use the following commands:
+
+
```
- git clone git@github.com:cristianmarint/sicily-hugo-theme.git
- cd sicily-hugo-theme/exampleSite/
- hugo server --themesDir ../..
+
+git clone git@github.com:cristianmarint/sicily-hugo-theme.git
+
+cd sicily-hugo-theme/exampleSite/
+
+hugo server --themesDir ../..
+
```
+
+
## Reporting Issues
+
+
We use GitHub Issues as the official bug tracker for the **sicily**. Please Search [existing issues](https://github.com/cristianmarint/sicily-hugo-theme/issues). It’s possible someone has already reported the same problem.
+
If your problem or idea is not addressed yet, [open a new issue](https://github.com/cristianmarint/sicily-hugo-theme/issues/new)
-## Technical Support or Questions (Paid)
+
+
+## Technical Support or Questions
+
+
-If you have questions or need help integrating the product please [contact us](mailto:mehedi@cristianmarint.com) instead of opening an issue.
+If you have questions or need help, opening an issue is the way to go!
+
+
## Licensing
+
+
- Copyright 2020 Designed by [cristianmarint](https://cristianmarint.com/) & Developed by [Gethugothemes](https://gethugothemes.com/)
-- Licensed under MIT (https://github.com/cristianmarint/sicily-hugo-theme/blob/master/LICENSE)
-### Donate Us (Author)
+- Licensed under [MIT](https://github.com/cristianmarint/sicily-hugo-theme/blob/master/LICENSE)
+
+
+
+### Donate Us (Author)
+
This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated . Thank you!
-* **[Donate $10](https://www.paypal.me/cristianmarint/10USD)**: Thank's for creating this project, here's a tea (or some juice) for you!
-* **[Donate $100](https://www.paypal.me/cristianmarint/100USD)**: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
-* **[Donate $1500](https://www.paypal.me/cristianmarint/1500USD)**: Go buddy, buy Macbook Pro for yourself!
+
+
+* **[Donate $10](https://www.paypal.me/cristianmarint/10USD)**: Thank's for creating this project, here's a tea (or some juice) for you!
+
+* **[Donate $100](https://www.paypal.me/cristianmarint/100USD)**: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
+
+* **[Donate $1500](https://www.paypal.me/cristianmarint/1500USD)**: Go buddy, buy Macbook Pro for yourself!
+
+
-Of course, you can also choose what you want to donate, all donations are awesome !
+Of course, you can also choose what you want to donate, all donations are awesome ! \ No newline at end of file