Lanyon update
This commit is contained in:
Alexandre Vicenzi
parent
a56b6f866f
commit
6283825517
28 changed files with 452 additions and 474 deletions
273
README.md
273
README.md
|
|
@ -1,219 +1,94 @@
|
|||
# Hyde
|
||||
|
||||
Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
|
||||
It pairs a prominent sidebar with uncomplicated content.
|
||||
|
||||
|
||||
|
||||
|
||||
## Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Options](#options)
|
||||
- [Sidebar menu](#sidebar-menu)
|
||||
- [Sidebar description](#sidebar-description)
|
||||
- [Sticky sidebar content](#sticky-sidebar-content)
|
||||
- [Themes](#themes)
|
||||
- [Reverse layout](#reverse-layout)
|
||||
- [Disqus](#disqus)
|
||||
- [Google Analytics](#google-analytics)
|
||||
- [Author](#author)
|
||||
- [Ported by](#ported-by)
|
||||
- [License](#license)
|
||||
# Lanyon
|
||||
|
||||
Lanyon is a minimalist brazen two-column [hugo](https://gohugo.io) theme based on [Hyde](https://github.com/spf13/hyde) and inspired by the success of [Flex](https://github.com/alexandrevicenzi/Flex).
|
||||
|
||||
## Installation
|
||||
|
||||
### Quick Start
|
||||
|
||||
To give you a running start this installation puts a fully configured [starter repo](https://github.com/forestryio/hyde-hugo-starter) into your Git account and sets it up in a content manager / CMS.
|
||||
|
||||
_[Forestry](https://forestry.io) Starter-Kit:_
|
||||
|
||||
[](https://app.forestry.io/quick-start?repo=forestryio/hyde-hugo-starter&provider=github&engine=hugo&version=0.49)
|
||||
|
||||
### Standard Installation
|
||||
|
||||
To install Hyde as your default theme, first install this repository in the `themes/` directory:
|
||||
To install Lanyon as your default theme, first install this repository in the `themes/` directory:
|
||||
|
||||
$ cd themes/
|
||||
$ git clone https://github.com/spf13/hyde.git
|
||||
$ git clone https://github.com/alexandrevicenzi/lanyon.git
|
||||
|
||||
Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
|
||||
Second, specify `lanyon` as your default theme in the `config.toml` file. Just add the line
|
||||
|
||||
theme = "hyde"
|
||||
theme = "lanyon"
|
||||
|
||||
at the top of the file.
|
||||
|
||||
## Configuration
|
||||
|
||||
## Options
|
||||
|
||||
Hyde includes some customizable options, typically applied via classes on the `<body>` element.
|
||||
|
||||
|
||||
### Sidebar menu
|
||||
|
||||
Create a list of nav links in the sidebar by assigning "menu=main" in the front matter, like so:
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
theme = "hyde"
|
||||
baseURL = "https://example.com"
|
||||
title = "Lanyon"
|
||||
author = "Author Name"
|
||||
languageCode = "en"
|
||||
enableInlineShortcodes = true
|
||||
|
||||
[Menus]
|
||||
main = [
|
||||
{Name = "Github", URL = "https://github.com/username/"},
|
||||
{Name = "LinkedIn", URL = "https://www.linkedin.com/in/username/"}
|
||||
]
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
theme: "hyde"
|
||||
|
||||
Menus:
|
||||
main:
|
||||
- Name: "Github"
|
||||
URL: "https://github.com/username/"
|
||||
- Name: "LinkedIn"
|
||||
URL: "https://www.linkedin.com/in/username/"
|
||||
```
|
||||
|
||||
### Sidebar description
|
||||
Customise the describe of your page using `description`, like so:
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
theme = "hyde"
|
||||
summarylength = 10
|
||||
enableEmoji = true
|
||||
|
||||
[params]
|
||||
description = "Your custom description"
|
||||
description = "My Blog"
|
||||
|
||||
## Set one of:
|
||||
# gravatar = "lanyon@example.com"
|
||||
profilePicture = "images/profile.png"
|
||||
|
||||
copyright = "Author Name"
|
||||
license = "CC BY-SA 4.0"
|
||||
licenseURL = "https://creativecommons.org/licenses/by-sa/4.0"
|
||||
|
||||
## Set custom theme color.
|
||||
# themeColor = "#fc2803"
|
||||
|
||||
## Set custom CSS and/or JS to override site defaults.
|
||||
customCss = ["css/blog.css"]
|
||||
customJs = ["js/blog.js"]
|
||||
|
||||
## Set as many as you want.
|
||||
[[params.socialIcons]]
|
||||
icon = "fa-linkedin"
|
||||
title = "Linkedin"
|
||||
url = "#"
|
||||
|
||||
[[params.socialIcons]]
|
||||
icon = "fa-github"
|
||||
title = "GitHub"
|
||||
url = "#"
|
||||
|
||||
[[params.socialIcons]]
|
||||
icon = "fa-twitter"
|
||||
title = "Twitter"
|
||||
url = "#"
|
||||
|
||||
[menu]
|
||||
|
||||
[[menu.main]]
|
||||
name = "Posts"
|
||||
weight = 100
|
||||
identifier = "posts"
|
||||
url = "/posts/"
|
||||
|
||||
[[menu.main]]
|
||||
name = "About"
|
||||
identifier = "about"
|
||||
weight = 300
|
||||
url = "/about/"
|
||||
|
||||
[markup]
|
||||
|
||||
[markup.highlight]
|
||||
codeFences = true
|
||||
guessSyntax = false
|
||||
hl_Lines = ""
|
||||
lineNoStart = 1
|
||||
lineNos = false
|
||||
lineNumbersInTable = true
|
||||
noClasses = true # if false, you need to provide you own custom CSS
|
||||
style = "monokai"
|
||||
tabWidth = 4
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
theme: "hyde"
|
||||
|
||||
params:
|
||||
description = "Your custom description"
|
||||
```
|
||||
|
||||
|
||||
### Sticky sidebar content
|
||||
|
||||
By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disabled this by removing the `.sidebar-sticky` class from the sidebar's `.container`. Sidebar content will then normally flow from top to bottom.
|
||||
|
||||
```html
|
||||
<!-- Default sidebar -->
|
||||
<div class="sidebar">
|
||||
<div class="container sidebar-sticky">
|
||||
...
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Modified sidebar -->
|
||||
<div class="sidebar">
|
||||
<div class="container">
|
||||
...
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
|
||||
### Themes
|
||||
|
||||
Hyde ships with eight optional themes based on the [base16 color scheme](https://github.com/chriskempson/base16). Apply a theme to change the color scheme (mostly applies to sidebar and links).
|
||||
|
||||
|
||||
|
||||
There are eight themes available at this time.
|
||||
|
||||
|
||||
|
||||
To use a theme, add the `themeColor` variable under `params`, like so:
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
theme = "hyde"
|
||||
|
||||
[params]
|
||||
themeColor = "theme-base-09"
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
theme: "hyde"
|
||||
|
||||
params:
|
||||
themeColor: "theme-base-09"
|
||||
```
|
||||
|
||||
To create your own theme, look to the Themes section of [included CSS file](https://github.com/poole/hyde/blob/master/public/css/hyde.css). Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
|
||||
|
||||
### Reverse layout
|
||||
|
||||
|
||||
|
||||
To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
theme = "hyde"
|
||||
|
||||
[params]
|
||||
layoutReverse = true
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
theme: "hyde"
|
||||
|
||||
params:
|
||||
layoutReverse: true
|
||||
```
|
||||
|
||||
### Disqus
|
||||
|
||||
You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to your config file.
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
disqusShortname = "spf13"
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
disqusShortname : spf13
|
||||
```
|
||||
|
||||
> **Note:** Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block.
|
||||
|
||||
|
||||
## Google Analytics
|
||||
|
||||
Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file:
|
||||
|
||||
**TOML**
|
||||
```toml
|
||||
googleAnalytics = "Your tracking code"
|
||||
```
|
||||
|
||||
**YAML**
|
||||
```yaml
|
||||
googleAnalytics: Your tracking code
|
||||
```
|
||||
|
||||
## Author
|
||||
**Mark Otto**
|
||||
- <https://github.com/mdo>
|
||||
- <https://twitter.com/mdo>
|
||||
|
||||
## Ported By
|
||||
**Steve Francia**
|
||||
- <https://github.com/spf13>
|
||||
- <https://twitter.com/spf13>
|
||||
|
||||
## License
|
||||
|
||||
Open sourced under the [MIT license](LICENSE.md).
|
||||
|
||||
<3
|
||||
MIT
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue