Permalink
Browse files

Initial commit

  • Loading branch information...
shenoybr committed Oct 8, 2016
0 parents commit 6801b3e77eddc7f4912df57f15255038dba35d9d
@@ -0,0 +1,4 @@
exampleSite/public
.DS_Store
*/**/.DS_Store
*.sw*
@@ -0,0 +1,9 @@
The MIT License (MIT)
Copyright (c) 2016 [Rajesh Shenoy](https://github.com/shenoybr)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
189 README.md
@@ -0,0 +1,189 @@
# Goa
Goa is a clean, simple and minimalist theme for blogs and personal websites.
## Screenshots
![Homepage](http://imgur.com/vqMd1Mx)
![Standalone Page](http://imgur.com/dfj8MHz)
![Standalone with Metadata](http://imgur.com/mMFfkZY)
![List Page](http://imgur.com/7e67ypn)
![Post Page](http://imgur.com/lz3RGH9)
![Nav](http://imgur.com/IPggNGk)
![Mobile Homepage](http://imgur.com/FW1Bdln)
![Mobile List](http://imgur.com/vTY5GeX)
![Mobile Post](http://imgur.com/aJZQYZ6)
![Mobile Nav](http://imgur.com/rGQJAF3)
## Installation
From the root of your blog:
```
mkdir -p themes
cd themes
git clone github.com/shenoybr/hugo-goa
```
## Content creation
### Creating a post
To create a new page or post:
````
hugo new about.md
````
or
````
hugo new posts/first.md
````
You can now go ahead an edit the newly created file under the `content` directory. Once you are finished editing, to have hugo generate the page, set `draft = false` in the articles front matter.
### Organizing pages
The above example demonstrates how to create a pages and posts. Hugo automatically applies the list templates for a directory of pages/posts, which works well for blogs and posts. However, you may want at times want to override this behavior and create a standalone page (like an about page or projects page) or have more control of what content is listed from within the directory. In such cases, you can override the default behavior by placing an index.md file in the corresponding content
directory.
````
hugo new projects/index.md
````
## Configuration
The provided [config.toml]() describes all options and features that are supported. Configure it your way!
### Basic Configuration
These are site wide configuration parameters that are used by this template.
`baseurl`: This is the root of your site.
`builddrafts`: default=`false`. Enables or Disable building drafts when hugo is run.
`canonifyurls`: default=`false`. Prefix all relative URLs with your base URL. [More Information](https://gohugo.io/extras/urls#canonicalization).
`languageCode`: Used to set site localization preferences. eg. `en-US`.
`contentdir`: Where hugo can find your content. eg. `content`.
`layoutdir`: Where hugo can find your templates. eg. `layouts`.
`publishdir`: Where hugo generates the static site. eg. `public`.
`author`: Site author name. eg. `Erlich Bachman`.
`title`: Site title name. eg. `Erlich Bachman`.
`theme`: Your theme name should be set to `hugo-goa` if using this theme.
## Hugo Built-in Features
These are features that hugo provides and are used by this template.
`disqusShortname`: Your discusShortname if you want to enable comments on your posts.
`googleAnalytics`: Your google analytics id for tracking.
`enableRobotsTXT`: Enable or disable search engines from crawling your site.
## Site Settings `[params]`
These are settings that are specific to this theme.
`intro`: Author introduction. This field supports markdown. eg. `Startup Guru Extraordinaire`.
`description`: Author description. This field supports markdown. eg. `Now @Pied Piper. Previously @Hacker Hostel, @Bachmanity and @Aviato. <br/> \"What is F times 5? It's Fleventy-five.\"`.
`authorImage`: Location of author image under static/img directory. eg. `headshot.jpg`
`dateFormat`: Golang date format to be used on this site. eg. `Jan 2, 2006`
### Site Meta Settings `[params.meta]`
These settings are included in the site's meta section.
`description`: User this field to describe your site to search engines. eg. `Simple minimalist theme`.
`keywords`: Keywords that desribe your site. eg. `minimalist,blog,goa,hugo,developer`.
### Social Accounts `[params.social]`
These settings to display your social accounts.
`github`: Your github username.
`instagram`: Your instagram username.
`linkedIn`: Your linkedIn username.
`twitter`: Your twitter username.
`facebook`: Your facebook username.
`google`: Your google username.
`email`: Your email.
### Extras `[params.extra]`
These settings for extra features that this site uses.
`copyright`: Add a copyright statement to the bottom of the theme. eg. `© 2016. Erlich Bachman. [Some Rights Reserved](http://creativecommons.org/licenses/by/3.0/)."`
`poweredBy`: Help promote this theme and give the authors credit. eg. `true` or `false`.
`hightlightJS`: Use highlightJS to highlight code on your site. eg. `true` or `false`.
### Main Menu `[[menu.main]]`
These settings for the main menu that is displayed on the home page.
`name`: Name of menu item. eg. `blog`
`weight`: Weight of this menu item. Higher items go to the bottom. eg. `100`
`url`: Root URL for this section/page. eg. `/blog/`.
Example:
```
[[menu.main]]
name = "blog"
weight = 100
url = "/blog/"
[[menu.main]]
name = "about"
weight = 200
url = "/about/"
[[menu.main]]
name = "coderag"
weight = 300
url = "/coderag/"
```
## Features
* Responsive
* Minimalist
* Bootstrap 3
* Fontawesome
* HighlighJS
* Disqus support for commenting
* Built-in support for 404 pages, Disqus comments and Google Analytics.
## Contributing
### Bug Reports
1. Search Github Issues to see if the bug has been previously filed.
2. If it has been filed, +1 the post. This helps us in assessing impact and priortitizing the bug.
3. If not previously filed, open a new Github Issue and describe in detail. Attach error traces and provide relavant details to help us solve it.
4. For Hugo issues, search the Hugo [Forum](https://discuss.gohugo.io/)
### Feature Requests
1. Search Github Issues to see if the feature has been previously requested.
2. If it has been filed, +1 the post. This helps us in assessing popularity and priortitizing the feature.
3. If not previously filed, open a new Github Issue and describe it in detail.
### Pull Requests
1. Clone the repository, create the feature/bug branch.
2. Code.
3. Make sure your code follows the style of the project.
4. Test it thoroughly.
5. Open a PR requesting for it to be merged.
6. Describe the feature or issue your are solving in detail.
7. Wait for its approval.
8. Merge and Rejoice.
## Attribution
The theme's design was inspired by many blogs and themes:
1. Bruno de Carvalho's [blog](biasedbit.com).
2. [Hugo Cocoa](http://themes.gohugo.io/cocoa/).
3. [Hugo Vec](http://themes.gohugo.io/hugo-theme-vec/).
3. [Hugo Agency](http://themes.gohugo.io/hugo-agency/).
## License
Licensed under the MIT License. See the [LICENSE](https://github.com/nishanths/cocoa-hugo-theme/blob/master/LICENSE.md) file for more details.
@@ -0,0 +1,9 @@
+++
draft = false
comments = false
slug = ""
tags = []
categories = []
showpagemeta = true
+++
@@ -0,0 +1,5 @@
{{ partial "header.html" . }}
{{ partial "error.html" . }}
{{ partial "footer.html" . }}
@@ -0,0 +1,7 @@
{{ partial "header.html" . }}
{{ partial "li.html" . }}
{{ partial "menu.html" . }}
{{ partial "footer.html" . }}
@@ -0,0 +1,8 @@
{{ partial "header.html" . }}
{{ partial "content.html" . }}
{{ partial "menu.html" . }}
{{ partial "footer.html" . }}
@@ -0,0 +1,11 @@
{{ partial "header.html" . }}
{{ partial "avatar.html" . }}
{{ partial "info.html" . }}
{{ partial "social.html" . }}
{{ partial "main_menu.html" . }}
{{ partial "footer.html" . }}
@@ -0,0 +1,4 @@
<header class="row text-center header">
{{ with .Site.Params.authorImage }} <img src="img/{{ . }}" alt="Author Image" class="img-circle text-center headshot"> {{ end }}
<h1 class="author">{{ .Site.Author }}</h1>
</header>
@@ -0,0 +1,41 @@
<header class="row text-left title">
<h1 class="title">{{ .Title }}</h1>
</header>
<section id="category-pane" class="row meta">
{{ if ne .Params.showpagemeta false }}
<div class="col-md-12">
<h6 class="text-left meta">
PUBLISHED ON {{ .Date.Format .Site.Params.dateFormat | upper }}
{{ $total := len .Params.categories }}
{{ if gt $total 0 }}
{{ $total := sub $total 1 }}
{{ range $i, $cat := sort $.Params.categories }}
<a class="meta" href="{{ "/categories/" | relURL }}{{ $cat | urlize }}">{{ $cat | upper }}</a>{{ if lt $i $total }}, {{ end }}
{{ end }}
{{ end }}
</h6>
</div>
{{ end }}
</section>
<section id="content-pane" class="row">
<div class="col-md-12 text-justify content">
{{ .Content }}
</div>
</section>
<section id="tag-pane" class="row meta">
{{ if ne .Params.showpagemeta false }}
<div class="col-md-12">
<h6 class="text-right meta">
{{ $total := len .Params.tags }}
{{ if gt $total 0 }}
TAGS:
{{ $subtotal := sub $total 1 }}
{{ range $i, $tag := sort $.Params.tags }}
<a class="meta" href="{{ "/tags/" | relURL }}{{ $tag | urlize }}">{{ $tag | upper }}</a>{{ if lt $i $subtotal }}, {{ end }}
{{ end }}
{{ end }}
</h6>
</div>
{{ end }}
</section>
@@ -0,0 +1,4 @@
<section id="error-pane" class="row text-center error">
<h1 class="text-center">404</h1>
<p>Sorry! That page does not exist. It may have been removed or moved to a new section on the site. Click <a href="/">here</a> go back to the home page.</p>
</section>
@@ -0,0 +1,19 @@
{{ partial "sub_footer.html" . }}
</div>
{{ with .Site.Params.extra }}
{{ if .highlightJS }}
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.6.0/highlight.min.js"></script>
<script type="text/javascript">
hljs.initHighlightingOnLoad();
</script>
{{ end }}
{{ end }}
{{ template "_internal/google_analytics_async.html" . }}
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<script src="js/main.js"></script>
</body>
</html>
@@ -0,0 +1,48 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode }}">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
{{ with .Site.Params.meta.description }}<meta name="description" content="{{ . }}">{{ end }}
{{ with .Site.Params.meta.keywords }}<meta name="keywords" content="{{.}}">{{ end }}
<base href="{{ .Site.BaseURL }}">
<title>{{ .Site.Title }}</title>
{{ .Hugo.Generator }}
{{ if .RSSlink }}
<link href="{{ . }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
<link href="{{ . }}" rel="feed" type="application/rss+xml" title="{{ .Site.Title }}" />
{{ end }}
{{ if .Site.Params.extra.highlightJS }}
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.6.0/styles/default.min.css">
{{ end }}
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,400|Roboto+Slab:400,700|Roboto:300,300i,400,400i,500,500i,700,700i">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css">
<link rel="stylesheet" href="{{ "css/main.css" | absURL }}">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
<meta name="theme-color" content="#ffffff">
</head>
<body lang="{{ .Site.LanguageCode }}">
<div class="container">
@@ -0,0 +1,8 @@
<section id="info-pane" class="row text-center info">
{{ with .Site.Params.intro }}
<h3 class="intro">{{ . | markdownify }}</h3>
{{ end }}
{{ with .Site.Params.description }}
<h4 class="description">{{ . | markdownify }}</h4>
{{ end }}
</section>
Oops, something went wrong.

0 comments on commit 6801b3e

Please sign in to comment.