new theme

This commit is contained in:
Harsh Shandilya 2017-01-15 03:31:22 +05:30
parent 02b9f86721
commit 5bd9426fec
34 changed files with 2747 additions and 1 deletions

View File

@ -1,7 +1,9 @@
Title = "Harsh Shandilya"
baseurl = "https://msfjarvis.me"
languageCode = "en-us"
theme = "hugo-theme-nix"
title = "Harsh Shandilya"
theme = "hugo-theme-vec"
paginate = 15
[params]
GithubID = "MSF-Jarvis"
@ -14,3 +16,8 @@ theme = "hugo-theme-nix"
Email = "msfjarvis@gmail.com"
About = "Code Review -1, Verified -2"
ProfilePicture = "images/avatar.png"
Keywords = "MSF Jarvis, Harsh Shandilya, Android, Golang"
Description = "Just a random guy who eats and......IDK, something"
Avatar = "https://avatars3.githubusercontent.com/u/13348378?v=3"
SelfIntro = "Just a worm, seek for true, live in shadow, no more..."

View File

@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2014 Ivan Chou
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.

View File

@ -0,0 +1,95 @@
# Vec
Vec is a minimal, clean and beautiful theme for [Hugo](http://gohugo.io/).
[Demo](http://yii.im).
![Vec screenshot](https://github.com/IvanChou/hugo-theme-vec/blob/master/images/tn.png)
![Vec screenshot2](https://github.com/IvanChou/hugo-theme-vec/blob/master/images/tn2.png)
## Installation
```
mkdir themes
cd themes
git clone https://github.com/IvanChou/hugo-theme-vec vec
```
See the [official docs](http://gohugo.io/themes/installing) for more information.
## Configuration
You should config your site's `config.toml` file like:
```
baseurl = "https://www.example.com"
title = "Site.title"
theme = "vec"
languageCode = "en-us"
paginate = 15
# Enable comments by entering your Disqus shortname
disqusShortname = "Your Disqus shortname"
# Enable analytics by entering your Google Analytics tracking ID
googleAnalytics = "Your Google Analytics tracking code"
[params]
Keywords = "key, 关键字, キーワード"
Description = "There are some words to describe your site"
Avater = "img/avatar.jpg"
SelfIntro = "Just a worm, seek for true, live in shadow, no more..."
Email = "you@example.com"
GithubID = "Your Github ID"
TwitterID = "Your Twitter ID"
FacebookID = "Your Facebook ID"
LinkedInID = "Your LinkedIn ID"
GoogleplusID = "Your Googleplus ID"
```
If you use `config.yaml`, plz reformat them to yaml.
### Enable Disqus to your post
1. Add your Disqus Shortname to the site config file;
2. You can enable Disqus per-post, by adding `comments: true` (YAML) or `comments = true` (TOML) in the front matter of your post. To disable it, you can either change the value to `false` or just not include `comments` variable and its value at all.
### Enable TOC to your post
If you need show table of contents per-post, adding `toc: true` (YAML) or `toc = true` (TOML) in the front matter of your post.
Please notice that TOC will be hidden when browser width is less than 920px.
### Enable Formspree to your page
If you need a form which allows guests to contact you by email, Formspree maybe a good choice.
Firstly, make sure you have already set a Email in the config.toml. And then add `formspree: true` (YAML) or `formspree = true` (TOML) in the front matter of your page.
## Build your site
Add `theme = "vec"` to your `config.toml`, then
```
# Build
hugo
# Run a server
hugo server
```
OR
```
hugo -t vec
hugo server -t vec
```
## License
Open sourced under [MIT license](https://github.com/IvanChou/hugo-theme-vec/blob/master/LICENSE.md).

View File

@ -0,0 +1,6 @@
+++
toc = false
draft = true
comments = false
slug = ""
+++

View File

@ -0,0 +1 @@
themes/

View File

@ -0,0 +1,35 @@
baseurl = "https://www.example.com"
title = "yii.im"
theme = "vec"
languageCode = "en-us"
paginate = 10
disqusShortname = "yiiim"
googleAnalytics = "UA-57408564-1"
[menu]
# Shown in the side menu.
[[menu.main]]
name = "post"
weight = 0
url = "/post"
[[menu.main]]
name = "contact"
weight = 1
url = "/contact"
[[menu.main]]
name = "faq"
weight = 2
url = "/faq"
[params]
Keywords = "key, 关键字, キーワード"
Description = "There are some words to describe your site"
Avater = "img/avatar.jpg"
SelfIntro = "Just a worm, seek for true, live in shadow, no more..."
Email = "yiichou@gmail.com"
GithubID = "Your Github ID"
TwitterID = "Your Twitter ID"
FacebookID = "Your Facebook ID"
LinkedInID = "Your LinkedIn ID"
GoogleplusID = "Your Googleplus ID"

View File

@ -0,0 +1,11 @@
+++
title = "Contact"
id = "contact"
formspree = true
+++
# We are here to help you
Are you curious about something? Do you have some kind of problem with our products? As am hastily invited settled at limited civilly fortune me. Really spring in extent an by. Judge but built gay party world. Of so am he remember although required. Bachelor unpacked be advanced at. Confined in declared marianne is vicinity.
Please feel free to contact us, our customer service center is working for you 24/7.

View File

@ -0,0 +1,41 @@
+++
title = "FAQ"
+++
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.
## 1. WHAT TO DO IF I HAVE STILL NOT RECEIVED THE ORDER?
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
* Aliquam tincidunt mauris eu risus.
* Vestibulum auctor dapibus neque.
## 2. WHAT ARE THE POSTAL RATES?
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
## 3. DO YOU SEND OVERSEAS?
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
## 4. WHY ARE YOU MORE EXPENSIVE THAN OTHERS?
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
* Aliquam tincidunt mauris eu risus.
* Vestibulum auctor dapibus neque.
## 5. ANOTHER IMPORTANT QUESTION
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
* Aliquam tincidunt mauris eu risus.
* Vestibulum auctor dapibus neque.
---
> In case you haven't found the answer for your question please feel free to contact us, our customer support will be happy to help you.

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,334 @@
+++
title = "Go is for lovers"
date = "2015-09-17T13:47:08+02:00"
tags = ["go"]
categories = ["programming"]
banner = "img/banners/banner-2.jpg"
+++
Hugo uses the excellent [go][] [html/template][gohtmltemplate] library for
its template engine. It is an extremely lightweight engine that provides a very
small amount of logic. In our experience that it is just the right amount of
logic to be able to create a good static website. If you have used other
template systems from different languages or frameworks you will find a lot of
similarities in go templates.
This document is a brief primer on using go templates. The [go docs][gohtmltemplate]
provide more details.
## Introduction to Go Templates
Go templates provide an extremely simple template language. It adheres to the
belief that only the most basic of logic belongs in the template or view layer.
One consequence of this simplicity is that go templates parse very quickly.
A unique characteristic of go templates is they are content aware. Variables and
content will be sanitized depending on the context of where they are used. More
details can be found in the [go docs][gohtmltemplate].
## Basic Syntax
Go lang templates are html files with the addition of variables and
functions.
**Go variables and functions are accessible within {{ }}**
Accessing a predefined variable "foo":
{{ foo }}
**Parameters are separated using spaces**
Calling the add function with input of 1, 2:
{{ add 1 2 }}
**Methods and fields are accessed via dot notation**
Accessing the Page Parameter "bar"
{{ .Params.bar }}
**Parentheses can be used to group items together**
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
## Variables
Each go template has a struct (object) made available to it. In hugo each
template is passed either a page or a node struct depending on which type of
page you are rendering. More details are available on the
[variables](/layout/variables) page.
A variable is accessed by referencing the variable name.
<title>{{ .Title }}</title>
Variables can also be defined and referenced.
{{ $address := "123 Main St."}}
{{ $address }}
## Functions
Go template ship with a few functions which provide basic functionality. The go
template system also provides a mechanism for applications to extend the
available functions with their own. [Hugo template
functions](/layout/functions) provide some additional functionality we believe
are useful for building websites. Functions are called by using their name
followed by the required parameters separated by spaces. Template
functions cannot be added without recompiling hugo.
**Example:**
{{ add 1 2 }}
## Includes
When including another template you will pass to it the data it will be
able to access. To pass along the current context please remember to
include a trailing dot. The templates location will always be starting at
the /layout/ directory within Hugo.
**Example:**
{{ template "chrome/header.html" . }}
## Logic
Go templates provide the most basic iteration and conditional logic.
### Iteration
Just like in go, the go templates make heavy use of range to iterate over
a map, array or slice. The following are different examples of how to use
range.
**Example 1: Using Context**
{{ range array }}
{{ . }}
{{ end }}
**Example 2: Declaring value variable name**
{{range $element := array}}
{{ $element }}
{{ end }}
**Example 2: Declaring key and value variable name**
{{range $index, $element := array}}
{{ $index }}
{{ $element }}
{{ end }}
### Conditionals
If, else, with, or, & and provide the framework for handling conditional
logic in Go Templates. Like range, each statement is closed with `end`.
Go Templates treat the following values as false:
* false
* 0
* any array, slice, map, or string of length zero
**Example 1: If**
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
**Example 2: If -> Else**
{{ if isset .Params "alt" }}
{{ index .Params "alt" }}
{{else}}
{{ index .Params "caption" }}
{{ end }}
**Example 3: And & Or**
{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
**Example 4: With**
An alternative way of writing "if" and then referencing the same value
is to use "with" instead. With rebinds the context `.` within its scope,
and skips the block if the variable is absent.
The first example above could be simplified as:
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
**Example 5: If -> Else If**
{{ if isset .Params "alt" }}
{{ index .Params "alt" }}
{{ else if isset .Params "caption" }}
{{ index .Params "caption" }}
{{ end }}
## Pipes
One of the most powerful components of go templates is the ability to
stack actions one after another. This is done by using pipes. Borrowed
from unix pipes, the concept is simple, each pipeline's output becomes the
input of the following pipe.
Because of the very simple syntax of go templates, the pipe is essential
to being able to chain together function calls. One limitation of the
pipes is that they only can work with a single value and that value
becomes the last parameter of the next pipeline.
A few simple examples should help convey how to use the pipe.
**Example 1 :**
{{ if eq 1 1 }} Same {{ end }}
is the same as
{{ eq 1 1 | if }} Same {{ end }}
It does look odd to place the if at the end, but it does provide a good
illustration of how to use the pipes.
**Example 2 :**
{{ index .Params "disqus_url" | html }}
Access the page parameter called "disqus_url" and escape the HTML.
**Example 3 :**
{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
Stuff Here
{{ end }}
Could be rewritten as
{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
Stuff Here
{{ end }}
## Context (aka. the dot)
The most easily overlooked concept to understand about go templates is that {{ . }}
always refers to the current context. In the top level of your template this
will be the data set made available to it. Inside of a iteration it will have
the value of the current item. When inside of a loop the context has changed. .
will no longer refer to the data available to the entire page. If you need to
access this from within the loop you will likely want to set it to a variable
instead of depending on the context.
**Example:**
{{ $title := .Site.Title }}
{{ range .Params.tags }}
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize | lower }}">{{ . }}</a> - {{ $title }} </li>
{{ end }}
Notice how once we have entered the loop the value of {{ . }} has changed. We
have defined a variable outside of the loop so we have access to it from within
the loop.
# Hugo Parameters
Hugo provides the option of passing values to the template language
through the site configuration (for sitewide values), or through the meta
data of each specific piece of content. You can define any values of any
type (supported by your front matter/config format) and use them however
you want to inside of your templates.
## Using Content (page) Parameters
In each piece of content you can provide variables to be used by the
templates. This happens in the [front matter](/content/front-matter).
An example of this is used in this documentation site. Most of the pages
benefit from having the table of contents provided. Sometimes the TOC just
doesn't make a lot of sense. We've defined a variable in our front matter
of some pages to turn off the TOC from being displayed.
Here is the example front matter:
```
---
title: "Permalinks"
date: "2013-11-18"
aliases:
- "/doc/permalinks/"
groups: ["extras"]
groups_weight: 30
notoc: true
---
```
Here is the corresponding code inside of the template:
{{ if not .Params.notoc }}
<div id="toc" class="well col-md-4 col-sm-6">
{{ .TableOfContents }}
</div>
{{ end }}
## Using Site (config) Parameters
In your top-level configuration file (eg, `config.yaml`) you can define site
parameters, which are values which will be available to you in chrome.
For instance, you might declare:
```yaml
params:
CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved."
TwitterUser: "spf13"
SidebarRecentLimit: 5
```
Within a footer layout, you might then declare a `<footer>` which is only
provided if the `CopyrightHTML` parameter is provided, and if it is given,
you would declare it to be HTML-safe, so that the HTML entity is not escaped
again. This would let you easily update just your top-level config file each
January 1st, instead of hunting through your templates.
```
{{if .Site.Params.CopyrightHTML}}<footer>
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
</footer>{{end}}
```
An alternative way of writing the "if" and then referencing the same value
is to use "with" instead. With rebinds the context `.` within its scope,
and skips the block if the variable is absent:
```
{{with .Site.Params.TwitterUser}}<span class="twitter">
<a href="https://twitter.com/{{.}}" rel="author">
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
alt="Twitter"></a>
</span>{{end}}
```
Finally, if you want to pull "magic constants" out of your layouts, you can do
so, such as in this example:
```
<nav class="recent">
<h1>Recent Posts</h1>
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
{{end}}</ul>
</nav>
```
[go]: <http://golang.org/>
[gohtmltemplate]: <http://golang.org/pkg/html/template/>

View File

@ -0,0 +1,79 @@
+++
title = "Hugo is for lovers"
date = "2015-08-03T13:39:46+02:00"
toc = true
comments = true
+++
## Step 1. Install Hugo
Goto [hugo releases](https://github.com/spf13/hugo/releases) and download the
appropriate version for your os and architecture.
Save it somewhere specific as we will be using it in the next step.
More complete instructions are available at [installing hugo](/overview/installing/)
## Step 2. Build the Docs
Hugo has its own example site which happens to also be the documentation site
you are reading right now.
Follow the following steps:
1. Clone the [hugo repository](http://github.com/spf13/hugo)
2. Go into the repo
3. Run hugo in server mode and build the docs
4. Open your browser to http://localhost:1313
Corresponding pseudo commands:
git clone https://github.com/spf13/hugo
cd hugo
/path/to/where/you/installed/hugo server --source=./docs
> 29 pages created
> 0 tags index created
> in 27 ms
> Web Server is available at http://localhost:1313
> Press ctrl+c to stop
Once you've gotten here, follow along the rest of this page on your local build.
## Step 3. Change the docs site
Stop the Hugo process by hitting ctrl+c.
Now we are going to run hugo again, but this time with hugo in watch mode.
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
> 29 pages created
> 0 tags index created
> in 27 ms
> Web Server is available at http://localhost:1313
> Watching for changes in /Users/spf13/Code/hugo/docs/content
> Press ctrl+c to stop
Open your [favorite editor](http://vim.spf13.com) and change one of the source
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
Content files are found in `docs/content/`. Unless otherwise specified, files
are located at the same relative location as the url, in our case
`docs/content/overview/quickstart.md`.
Change and save this file.. Notice what happened in your terminal.
> Change detected, rebuilding site
> 29 pages created
> 0 tags index created
> in 26 ms
Refresh the browser and observe that the typo is now fixed.
Notice how quick that was. Try to refresh the site before it's finished building.. I double dare you.
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
## Step 4. Have fun
The best way to learn something is to play with it.

View File

@ -0,0 +1,19 @@
+++
title = "Linked post"
date = "2015-10-02T21:49:20+02:00"
tags = ["golang", "programming", "theme", "hugo"]
categories = ["programming"]
banner = "img/banners/banner-4.jpg"
author = "John Doe"
+++
I'm a linked post in the menu. You can add other posts by adding the following line to the frontmatter:
menu = "main"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In mauris nulla, vestibulum vel auctor sed, posuere eu lorem. Aliquam consequat augue ut accumsan mollis. Suspendisse malesuada sodales tincidunt. Vivamus sed erat ac augue bibendum porta sed id ipsum. Ut mollis mauris eget ligula sagittis cursus. Aliquam id pharetra tellus. Pellentesque sed tempus risus. Proin id hendrerit ante. Vestibulum vitae urna ut mauris ultricies dignissim. Ut ante turpis, tristique vitae sagittis quis, sagittis nec diam. Fusce pulvinar cursus porta. Vivamus maximus leo dolor, ut pellentesque lorem fringilla nec. Mauris faucibus turpis posuere sapien euismod, a ullamcorper mi maximus.
Morbi varius ex vel justo dictum placerat. Sed ac arcu pretium, varius elit eget, gravida purus. Fusce sit amet massa mollis eros tincidunt sollicitudin. Suspendisse iaculis cursus mauris ut sagittis. Interdum et malesuada fames ac ante ipsum primis in faucibus. Maecenas elit ligula, molestie quis magna eu, semper posuere lorem. Mauris a justo pharetra, congue ex eget, tincidunt massa. Maecenas sit amet neque lorem.
Curabitur at elementum quam. Curabitur tristique elit non sapien aliquam vulputate. Vivamus in odio tincidunt, tempor sem quis, tincidunt lacus. Mauris pulvinar nunc sed tempus dictum. Nam vel arcu quis mi fermentum ullamcorper non ac lacus. Donec aliquet vitae ante at imperdiet. Aenean scelerisque venenatis urna, eget elementum risus convallis ac. Nullam gravida arcu lacus, non consectetur augue pretium non. Duis dignissim eros id urna pretium congue. Nullam eu magna in sem sollicitudin tempor. Pellentesque vel convallis ligula. Quisque semper, turpis a rhoncus efficitur, magna nibh iaculis elit, eget tempor dolor eros ut mi. Maecenas eu placerat lacus. Praesent congue pretium nulla, sed suscipit metus rutrum vel.

View File

@ -0,0 +1,152 @@
+++
title = "Migrate from Jekyll"
date = "2015-10-10T13:07:31+02:00"
toc = true
comments = true
+++
## Move static content to `static`
Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there.
With Jekyll, something that looked like
<root>/
▾ images/
logo.png
should become
<root>/
▾ static/
▾ images/
logo.png
Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
## Create your Hugo configuration file
Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details.
## Set your configuration publish folder to `_site`
The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives:
1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
git submodule deinit _site
git rm _site
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
2. Or, change the Hugo configuration to use `_site` instead of `public`.
{
..
"publishdir": "_site",
..
}
## Convert Jekyll templates to Hugo templates
That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way.
As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
## Convert Jekyll plugins to Hugo shortcodes
Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
### Implementation
As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.
Jekyll's plugin:
module Jekyll
class ImageTag < Liquid::Tag
@url = nil
@caption = nil
@class = nil
@link = nil
// Patterns
IMAGE_URL_WITH_CLASS_AND_CAPTION =
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
def initialize(tag_name, markup, tokens)
super
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
@class = $1
@url = $3
@caption = $7
@link = $9
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
@class = $1
@url = $3
@caption = $7
elsif markup =~ IMAGE_URL_WITH_CAPTION
@url = $1
@caption = $5
elsif markup =~ IMAGE_URL_WITH_CLASS
@class = $1
@url = $3
elsif markup =~ IMAGE_URL
@url = $1
end
end
def render(context)
if @class
source = "<figure class='#{@class}'>"
else
source = "<figure>"
end
if @link
source += "<a href=\"#{@link}\">"
end
source += "<img src=\"#{@url}\">"
if @link
source += "</a>"
end
source += "<figcaption>#{@caption}</figcaption>" if @caption
source += "</figure>"
source
end
end
end
Liquid::Template.register_tag('image', Jekyll::ImageTag)
is written as this Hugo shortcode:
<!-- image -->
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
{{ if .Get "link"}}</a>{{ end }}
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
<figcaption>{{ if isset .Params "title" }}
{{ .Get "title" }}{{ end }}
{{ if or (.Get "caption") (.Get "attr")}}<p>
{{ .Get "caption" }}
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
{{ .Get "attr" }}
{{ if .Get "attrlink"}}</a> {{ end }}
</p> {{ end }}
</figcaption>
{{ end }}
</figure>
<!-- image -->
### Usage
I simply changed:
{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %}
to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
{{%/* fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" */%}}
As a bonus, the shortcode named parameters are, arguably, more readable.
## Finishing touches
### Fix content
Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server --watch` is your friend. Test your changes and fix errors as needed.
### Clean up
You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
## A practical example in a diff
[Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610).

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode }}">
<head>
<title> {{ .Title }} &middot; {{ .Site.Title }} </title>
{{ partial "head.html" . }}
</head>
<body>
{{ partial "header.html" . }}
<div class="content">
<section class="posts">
{{ $paginator := .Paginate (.Data.Pages.GroupByDate "2006-01") }}
{{ range $paginator.PageGroups }}
<div class="posts-archive">
{{ $month := (print .Key "-01") }}
<time class="posts-archive-month" datetime="{{ $month }}">{{ dateFormat "Jan 2006" $month }}</time>
<ol class="posts-list">
{{ range .Pages }}
<li><a href="{{ .Permalink }}">{{ .Title }}</a></li>
{{ end }}
</ol>
</div>
{{ end }}
</section>
{{ partial "pagination.html" . }}
</div>
{{ partial "footer.html" . }}
{{ partial "analytics.html" . }}
</body>
</html>

View File

@ -0,0 +1,44 @@
<!DOCTYPE html>
<html>
<head>
<title> {{ .Title }} &middot; {{ .Site.Title }} </title>
{{ partial "head.html" . }}
</head>
<body>
{{ partial "header.html" . }}
<div class="content">
{{ if .Params.toc }}{{ .TableOfContents }}{{ end }}
<section class="post">
<h1 class="post-title"><a href="{{ .Permalink }}">{{ .Title }}</a></h1>
<span class="post-date">{{ .Date.Format "Jan 2, 2006 " }}</span>
<div class="post-content">
{{ .Content }}
</div>
</section>
<section class="pagination clearfix">
{{ with .PrevInSection }}
<a class="btn previous " href="{{.Permalink}}"> {{ .Title }} </a>
{{ end }}
{{ with .NextInSection }}
<a class="btn next " href="{{.Permalink}}"> {{ .Title }} </a>
{{ end }}
</section>
{{ if .Params.comments }}{{ partial "disqus.html" . }}{{ end }}
</div>
{{ partial "footer.html" . }}
<script src="{{ "js/highlight.min.js" | absURL }}"></script>
<script>
hljs.initHighlightingOnLoad();
</script>
{{ partial "analytics.html" . }}
</body>
</html>

View File

@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="{{ .Site.LanguageCode }}">
<head>
<title> {{ .Site.Title }} </title>
{{ with .Site.Params.Keywords }}<meta name="keywords" content="{{.}}">{{ end }}
{{ with .Site.Params.Description }}<meta name="description" content="{{.}}">{{ end }}
{{ partial "head.html" . }}
</head>
<body>
{{ partial "header.html" . }}
<section class="user-profile">
<figure class="user-avatar">
<img alt="avatar" src="{{ .Site.Params.Avatar }}">
<figcaption class="user-socials">
{{ with .Site.Params.TwitterID }}
<a href="https://twitter.com/{{.}}" title="Twitter"><i class="fa fa-twitter-square" aria-hidden="true"></i></a>
{{ end }}
{{ with .Site.Params.GoogleplusID }}
<a href="https://plus.google.com/{{.}}/about" title="Google+"><i class="fa fa-google-plus-square" aria-hidden="true"></i></a>
{{ end }}
{{ with .Site.Params.FacebookID }}
<a href="https://facebook.com/{{.}}" title="Facebook"><i class="fa fa-facebook-square" aria-hidden="true"></i></a>
{{ end }}
{{ with .Site.Params.GithubID }}
<a href="https://github.com/{{.}}" title="GitHub"><i class="fa fa-github-square" aria-hidden="true"></i></a>
{{ end }}
{{ with .Site.Params.LinkedInID }}
<a href="http://linkedin.com/in/{{.}}" title="LinkedIn"><i class="fa fa-linkedin-square" aria-hidden="true"></i></a>
{{ end }}
</figcaption>
</figure>
<p class="user-motivation">{{ .Site.Params.SelfIntro }}</p>
</section>
{{ partial "footer.html" . }}
{{ partial "analytics.html" . }}
</body>
</html>

View File

@ -0,0 +1,31 @@
<!DOCTYPE html>
<html>
<head>
<title> {{ .Title }} &middot; {{ .Site.Title }} </title>
{{ partial "head.html" . }}
</head>
<body>
{{ partial "header.html" . }}
<div class="content">
<section class="post">
<h1 class="post-title"><a href="{{ .Permalink }}">{{ .Title }}</a></h1>
<div class="post-content">
{{ .Content }}
</div>
{{ if .Params.formspree }}{{ partial "formspree.html" . }}{{ end }}
</section>
{{ if .Params.comments }}{{ partial "disqus.html" . }}{{ end }}
</div>
{{ partial "footer.html" . }}
{{ partial "analytics.html" . }}
</body>
</html>

View File

@ -0,0 +1,12 @@
{{ with .Site.GoogleAnalytics }}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{.}}', 'auto');
ga('send', 'pageview');
</script>
{{ end }}

View File

@ -0,0 +1,16 @@
{{ if .Site.DisqusShortname }}
<section id="disqus_thread" class='disqus'></section>
<script>
var disqus_config = function () {
this.page.url = {{ .Permalink }};
// this.page.identifier = PAGE_IDENTIFIER;
};
(function() {
var d = document, s = d.createElement('script');
s.src = '//{{ .Site.DisqusShortname }}.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
{{ end }}

View File

@ -0,0 +1,12 @@
<footer>
<div class="footer-info">
<p>
<a href="mailto:{{ .Site.Params.Email }}?subject="><i class="fa fa-envelope-o"></i> {{ .Site.Params.Email }} </a>
{
<a href="https://gohugo.io/" title="Hugo :: A fast and modern static website engine">Hugo {{ .Hugo.Version }}</a>,
<a href="https://github.com/IvanChou/yii.im" title="vec">Vec</a>
}
{<a href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="CC BY-NC-ND 3.0">CC BY-NC-ND 3.0</a>}
</p>
</div>
</footer>

View File

@ -0,0 +1,13 @@
{{ if .Site.Params.Email }}
<hr />
<div id="formspree" class='formspree'>
<h2>CONTACT ME</h2>
<form action="https://formspree.io/{{ .Site.Params.Email }}" method="POST">
<input type="text" name="_gotcha" style="display:none" />
<input type="hidden" name="subject" value="comment to: {{ .Title }}">
<input type="email" name="email" placeholder="Your email" required>
<textarea name="message" placeholder="Your message" rows=5 required></textarea>
<button type="submit">Send</button>
</form>
</div>
{{ end }}

View File

@ -0,0 +1,13 @@
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
{{ .Hugo.Generator }}
<!-- CSS -->
<link rel="stylesheet" href="{{ "css/vec.css" | absURL }}">
<!-- Icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.ico">
<!-- RSS -->
<link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />

View File

@ -0,0 +1,19 @@
<header>
<nav>
<ul>
{{ $title := lower .Title }}
{{ $section := lower .Section }}
<li class="pull-left {{ if .IsHome }}current{{ end }}">
<a href="{{ .Site.BaseURL }}">/home/{{ lower .Site.Title}}</a>
</li>
{{ range .Site.Menus.main }}
{{ $name := lower .Name }}
<li class="pull-left {{ if eq $name $title }}current{{ else if eq $section $name }}current{{ end }}">
<a href="{{ .URL }}">~/{{ lower .Name }}</a>
</li>
{{end}}
<li class="pull-right"><a href="{{ .RSSLink }}"><i class="fa fa-rss"></i></a></li>
</ul>
</nav>
</header>

View File

@ -0,0 +1,5 @@
<div class="pagination">
{{ if .Paginator.HasPrev }}
<a class="btn previous" href="{{ .Paginator.Prev.URL }}">Newer</a> {{ end }} {{ if .Paginator.HasNext }}
<a class="btn next" href="{{ .Paginator.Next.URL }}">Older</a> {{ end }}
</div>

View File

@ -0,0 +1,71 @@
/**
* GitHub Gist Theme
* Author : Louis Barranqueiro - https://github.com/LouisBarranqueiro
*/
.hljs {
display: block;
background: white;
padding: 0.5em;
color: #333333;
overflow-x: auto;
}
.hljs-comment,
.hljs-meta {
color: #969896;
}
.hljs-string,
.hljs-variable,
.hljs-template-variable,
.hljs-strong,
.hljs-emphasis,
.hljs-quote {
color: #df5000;
}
.hljs-keyword,
.hljs-selector-tag,
.hljs-type {
color: #a71d5d;
}
.hljs-literal,
.hljs-symbol,
.hljs-bullet,
.hljs-attribute {
color: #0086b3;
}
.hljs-section,
.hljs-name {
color: #63a35c;
}
.hljs-tag {
color: #333333;
}
.hljs-title,
.hljs-attr,
.hljs-selector-id,
.hljs-selector-class,
.hljs-selector-attr,
.hljs-selector-pseudo {
color: #795da3;
}
.hljs-addition {
color: #55a532;
background-color: #eaffea;
}
.hljs-deletion {
color: #bd2c00;
background-color: #ffecec;
}
.hljs-link {
text-decoration: underline;
}

View File

@ -0,0 +1,461 @@
@import url(//fonts.googleapis.com/css?family=Droid+Sans+Mono|Russo+One|Source+Sans+Pro:400,700);
@import url(//cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css);
@import "github-gist.scss";
$font-body: 'Source Sans Pro', 'PingFang SC', 'Microsoft YaHei', Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
$font-title: 'Russo One', 'Arial Black', 'Hiragino Sans GB', 'Microsoft YaHei', sans-serif;
$font-code: 'Droid Sans Mono', Consolas, "Liberation Mono", Menlo, Courier, monospace;
html {
height:100%;
}
body {
margin: 0;
padding:0;
min-height:100%;
font-family: $font-body;
font-size: 100%;
letter-spacing: .01rem;
position:relative;
}
h1,h2,h3,h4,h5,h6 {
font-family: $font-title;
font-weight: 700;
line-height: 1.25;
}
a {
color: #005580;
text-decoration: none;
&:hover {
color: #08c;
}
}
img,video {
max-width: 100%;
}
.pull-left {
float: left;
}
.pull-right {
float: right;
}
.clearfix::before,.clearfix::after {
display: table;
content: "";
line-height: 0
}
.clearfix::after {
clear: both
}
.content {
margin: 0 auto;
padding: 6rem 1.85rem 8rem;
max-width: 40rem;
}
@mixin awesome-fa {
display: inline-block;
font: normal normal normal 14px/1 FontAwesome;
font-size: inherit;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
/* ============== Header ============== */
header {
position: fixed;
top: 0;
width: 100%;
height: 1.75rem;
font-family: $font-code;
font-size: .875rem;
font-weight: bold;
background: #2d2d2d;
border-bottom: 1px solid #000;
z-index: 99;
ul,ol {
margin: 0;
padding: 0;
list-style: none
}
nav {
padding: 0 .5rem
}
.nav-center {
text-align: center;
line-height: 1.75rem;
color: #000;
text-transform: uppercase;
text-shadow: rgba(255,255,255,.098) 0 1px 0,rgba(255,255,255,.12) 0 0 1.875rem
}
a {
color: #bbb;
line-height: 1.75rem;
padding: 0 .5rem
}
a:hover, .current a {
color: #fff;
}
}
/* ============== Footer ============== */
footer {
position: absolute;
width: 100%;
padding: 1rem;
bottom: 0;
box-sizing: border-box;
color: #ccc;
a {
color: #ccc;
}
.footer-info {
border-top: .4rem double #f2f2f2;
padding-top: .25rem
}
}
/* ============== Index ============== */
.user-profile {
width: 100%;
padding: 4rem 1rem 8rem;
font-family: $font-title;
color: #888;
text-align: center;
box-sizing: border-box;
}
.user-profile .user-avatar {
margin: 1rem 0
}
.user-profile .user-avatar img {
width: 16rem;
height: 16rem
}
.user-profile .user-socials a {
color: #a7a7a7;
font-size: 1.25rem;
line-height: 1.5rem;
text-decoration: none
}
.user-profile .user-socials a:hover {
color: #777
}
.user-profile .user-motivation {
max-width: 56rem;
font-size: 4rem;
line-height: 4.125rem;
margin: 1rem auto
}
/* ============== List ============== */
.posts {
margin-left: -6rem;
.posts-archive {
margin-bottom: 3rem;
time {
display: block;
width: 10rem;
float: left;
font-family: $font-title;
font-size: 1.75rem;
text-align: right;
color: #CCCCCC;
font-weight: bold;
white-space: nowrap;
line-height: 1.25rem;
padding: .125rem 0;
}
ol {
margin-left: 12rem;
li {
margin-bottom: .5rem;
list-style: decimal;
}
}
}
}
/* ============== Page ============== */
.post {
color: #444;
line-height: 1.8;
width: 100%;
hr {
height: 0.25rem;
padding: 0;
margin: 1.5rem 0;
background-color: #e7e7e7;
border: 0;
}
em {
text-emphasis-style: circle;
text-emphasis-position: under;
}
code {
font-family: $font-code;
font-size: 0.85rem;
color: #555;
background-color: #f5f5f5;
border: 1px solid #eef;
border-radius: 3px;
padding: 0.2rem 0.5rem;
}
pre {
display: block;
margin: 0 0 1rem 0;
padding: 1rem;
font-size: 0.8rem;
line-height: 1.4;
white-space: pre;
white-space: pre-wrap;
word-break: break-all;
word-wrap: break-word;
background-color: #f5f5f5;
code {
font-size: 0.7rem;
padding: 0;
color: inherit;
border: none;
}
}
blockquote {
padding: 0.5rem 1rem;
margin: 0.8rem 0;
color: #7a7a7a;
border-left: 0.3rem solid #e5e5e5;
p:first-child {
margin-top: 0;
}
p:last-child {
margin-bottom: 0;
}
}
}
#TableOfContents {
border-radius: .25rem;
padding: 1rem;
background-color: #f7f7f7;
margin: 5rem 0 0 35rem;
position: absolute;
font-size: .875rem;
ul {
list-style: none;
margin: 0;
padding: 0;
}
a {
display: inline-block;
white-space: nowrap;
overflow: hidden;
max-width: 14rem;
text-overflow: ellipsis;
&:before {
content: '';
padding-right: .25rem;
}
}
a + ul {
padding-left: 1.5rem;
}
& ~ section {
margin-left: -6rem;
}
}
.pagination {
width: 100%;
margin: 4rem 0 0;
padding: 1.6rem 0;
border-top: 1px solid #e7e7e7;
a {
width: 42%;
overflow: hidden;
position: relative;
}
@mixin vertical-center {
position: absolute;
top: 50%;
margin-top: -.5rem;
}
.previous {
float: left;
padding-left: 1.25rem;
&:before {
@include awesome-fa;
@include vertical-center;
left: 0;
content: "\f053";
}
}
.next {
float: right;
text-align: right;
padding-right: 1.25rem;
&:after {
@include awesome-fa;
@include vertical-center;
right: 0;
content: "\f054";
}
}
}
.disqus {
width: 100%;
padding: 5rem 0 2rem;
border-top: 1px solid #e7e7e7;
}
/* ============== formspree ============== */
.formspree {
input, textarea {
font-size: 0.8rem;
border: 1px solid #ddd;
background: #fff;
padding: 0.5rem 2%;
margin: 1.2rem 1rem 1.2rem 0;
line-height: 1.5rem;
width: 96%;
border: 1px solid #ddd;
border-radius: 3px;
display: block;
}
input {
max-width: 25rem;
}
button {
float: right;
color: #999;
font-weight: bold;
border-radius: 3px;
border: 1px solid #d5d5d5;
background: #fff;
font-size: .8rem;
padding: .5rem 1.2rem;
&:hover {
background: #f5f5f5;
}
}
}
/* ============== media ============== */
@media (max-width: 480px) {
.content {
margin: 0 auto;
padding: 4rem 1rem 8rem;
}
.user-profile .user-avatar img {
width: 8rem;
height: 8rem
}
.user-profile .user-motivation {
font-size: 2.625rem;
line-height: 3.125rem
}
.pagination {
a {
font-size: .75rem;
}
.previous:before, .next:after {
margin-top: -.35rem;
}
}
}
@media (max-width: 920px) {
.posts {
margin-left: 0rem;
}
#TableOfContents {
display: none;
& ~ section {
margin-left: 0rem;
}
}
}
@media (max-width: 700px) {
.posts {
margin-left: 0rem;
.posts-archive {
time {
float: none;
text-align: left;
margin-bottom: 1rem;
}
ol {
margin-left: 0;
}
}
}
}

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,12 @@
name = "Vec"
license = "MIT"
licenselink = "https://github.com/IvanChou/hugo-theme-vec/blob/master/LICENSE.md"
description = "Vec -- a minimal theme for Hugo."
homepage = "https://github.com/IvanChou/hugo-theme-vec"
tags = ["minimal", "clean", "neat", "black white", "blog"]
features = ["blog"]
min_version = 0.15
[author]
name = "Ivan Chou"
homepage = "https://yii.im"