Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

10 cli context #11

Merged
merged 7 commits into from
May 11, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove submodule
  • Loading branch information
Christopher Davies committed May 11, 2019
commit d1fdb2197e06d0e0323b66c49700e07a2573e3ff
9 changes: 0 additions & 9 deletions .gitmodules

This file was deleted.

1 change: 0 additions & 1 deletion docs/themes/minimal
Submodule minimal deleted from 488ca0
1 change: 1 addition & 0 deletions docs/themes/minimal/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.vscode
20 changes: 20 additions & 0 deletions docs/themes/minimal/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2017 Calin Tataru

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.
85 changes: 85 additions & 0 deletions docs/themes/minimal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Minimal

Personal blog theme powered by [Hugo](https://gohugo.io).
A live demo is available [here](https://themes.gohugo.io/theme/minimal/).

## Installation

You can install the theme either as a clone or submodule.

I recommend the latter. From the root of your Hugo site, type the following:

```
$ git submodule add https://github.com/calintat/minimal.git themes/minimal
$ git submodule init
$ git submodule update
```

Now you can get updates to Minimal in the future by updating the submodule:

```
$ git submodule update --remote themes/minimal
```

## Configuration

After installation, take a look at the `exampleSite` folder inside `themes/minimal`.

To get started, copy the `config.toml` file inside `exampleSite` to the root of your Hugo site:

```
$ cp themes/minimal/exampleSite/config.toml .
```

Now edit this file and add your own information. Note that some fields can be omitted.

I recommend you use the theme's archetypes so now delete your site's `archetypes/default.md`.

## Features

You can tweak the look of the theme to suit your needs in a number of ways:

- The accent colour can be changed by using the `accent` field in `config.toml`.

- You can also change the background colour by using `backgroundColor`.

- Add colored 5px borders at the top and bottom of pages by setting `showBorder` to `true`.

For best results, I recommend you use a dark accent colour with a light background, for example:

```toml
[params]
accent = "red"
showBorder = true
backgroundColor = "white"
```

### Fonts

The theme uses [Google Fonts](https://fonts.google.com) to load its font. To change the font:

```toml
[params]
font = "Raleway" # should match the name on Google Fonts!
```

### Syntax highlighting

The theme supports syntax highlighting thanks to [highlight.js](https://highlightjs.org).

It's disabled by default, so you have to enable it by setting `highlight` to `true` in your config.

You can change the style used for the highlighting by using the `highlightStyle` field.

Only the "common" languages will be loaded by default. To load more, use `highlightLanguages`.

A list of all the available styles and languages can be found [here](https://highlightjs.org/static/demo/).

Please note the style and languages should be written in hyphen-separated lowercase, for example:

```toml
[params]
highlight = true
highlightStyle = "solarized-dark"
highlightLanguages = ["go", "haskell", "kotlin", "scala", "swift"]
```
5 changes: 5 additions & 0 deletions docs/themes/minimal/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
date: {{ dateFormat "2006-01-02" .Date }}
draft: true
---
6 changes: 6 additions & 0 deletions docs/themes/minimal/archetypes/post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
date: {{ dateFormat "2006-01-02" .Date }}
tags: []
draft: true
---
8 changes: 8 additions & 0 deletions docs/themes/minimal/archetypes/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
description: ""
repo: ""
tags: []
weight: 0
draft: true
---
62 changes: 62 additions & 0 deletions docs/themes/minimal/exampleSite/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
baseURL = "http://example.com/"
languageCode = "en-us"
title = "Minimal"
theme = "minimal"
disqusShortname = "username" # delete this to disable disqus comments
googleAnalytics = ""

[params]
author = "Calin Tataru"
description = "Personal blog theme powered by Hugo"
githubUsername = "#"
accent = "red"
showBorder = true
backgroundColor = "white"
font = "Raleway" # should match the name on Google Fonts!
highlight = true
highlightStyle = "solarized-dark"
highlightLanguages = ["go", "haskell", "kotlin", "scala", "swift"]

[[menu.main]]
url = "/"
name = "Home"
weight = 1

[[menu.main]]
url = "/post/"
name = "Posts"
weight = 2

[[menu.main]]
url = "/project/"
name = "Projects"
weight = 3

# Social icons to be shown on the right-hand side of the navigation bar
# The "name" field should match the name of the icon to be used
# The list of available icons can be found at http://fontawesome.io/icons/

[[menu.icon]]
url = "mailto:me@example.com"
name = "envelope-o"
weight = 1

[[menu.icon]]
url = "https://github.com/username/"
name = "github"
weight = 2

[[menu.icon]]
url = "https://twitter.com/username/"
name = "twitter"
weight = 3

[[menu.icon]]
url = "https://www.linkedin.com/in/username/"
name = "linkedin"
weight = 4

[[menu.icon]]
url = "https://www.stackoverflow.com/username/"
name = "stack-overflow"
weight = 5
Loading