diff options
| author | Gökmen Görgen <gkmngrgn@gmail.com> | 2019-09-26 20:52:49 +0300 |
|---|---|---|
| committer | Gökmen Görgen <gkmngrgn@gmail.com> | 2019-09-26 20:52:49 +0300 |
| commit | 011c10419d2c1b24cdfae2b288b7b6ac65ab6986 (patch) | |
| tree | 2560890176bfb5490d7e5311998c9c35e89a98a6 | |
| parent | 660b257ab8c248b936abda519e1493175c886a75 (diff) | |
add CONTRIBUTING.md.
| -rw-r--r-- | CONTRIBUTING.md | 15 | ||||
| -rw-r--r-- | exampleSite/content/_index.md | 2 |
2 files changed, 15 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..45fe896 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +The easiest way to contribute to the project is by using the 'exampleSite' folder. If you already have a website using Hugo, you can set the theme and start to contribute quickly. + +1. First of all, fork the project and clone it to your local. +2. Install [Hugo](https://gohugo.io/), enter the repository folder using your favorite terminal and run this command: + +``` +hugo server --contentDir='./exampleSite/content' +``` + +## Helpful Links + +- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +- [Introduction to Hugo Templating](https://gohugo.io/templates/introduction/) diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 23550b1..9704c25 100644 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -4,8 +4,6 @@ date = "2014-04-09" menu = "main" +++ - - A **Cocoa Enhaced** based theme. It's rewritten with **Bootstrap 4**. Websites that are using hugo with alaGeek theme: |