adapt to npf.io themes and add social stuffs
This commit is contained in:
Huy Tran
parent
5814b3e80c
commit
331ef48d5c
27 changed files with 1980 additions and 178 deletions
157
README.md
157
README.md
|
|
@ -1,7 +1,6 @@
|
|||
# Hyde
|
||||
# hyde-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.
|
||||
__`hyde-hyde`__ is a [Hugo](https://gohugo.io)'s theme derived from @spf13's [Hyde](https://github.com/spf13/hyde.git) which is in turn ported from @mdo Jekyll's [Hyde](https://github.com/poole/hyde).
|
||||
|
||||
|
||||
|
||||
|
|
@ -9,13 +8,6 @@ It pairs a prominent sidebar with uncomplicated content.
|
|||
## Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Options](#options)
|
||||
- [Sidebar menu](#sidebar-menu)
|
||||
- [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)
|
||||
|
|
@ -23,144 +15,47 @@ It pairs a prominent sidebar with uncomplicated content.
|
|||
|
||||
## Installation
|
||||
|
||||
To install Hyde as your default theme, first install this repository in the `themes/` directory:
|
||||
`hyde-hyde` can be easily installed as other themes:
|
||||
|
||||
$ cd themes/
|
||||
$ git clone https://github.com/spf13/hyde.git
|
||||
```sh
|
||||
$ cd HUGO_SITE
|
||||
# then clone hyde-hyde
|
||||
$ git clone https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde
|
||||
# or add hyde-hyde as a submodule
|
||||
$ git submodule add https://github.com/htr3n/hyde-hyde.git themes/hyde-hyde
|
||||
```
|
||||
|
||||
Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
|
||||
Then indicate `hyde-hyde` as the main theme
|
||||
|
||||
theme = "hyde"
|
||||
* `config.toml`
|
||||
|
||||
at the top of the file.
|
||||
theme = "hyde-hyde"
|
||||
* `config.yaml`
|
||||
|
||||
```
|
||||
theme : "hyde-hyde"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
Hyde includes some customizable options, typically applied via classes on the `<body>` element.
|
||||
* `hyde-hyde` essentially inherits all options from [Hyde](https://github.com/spf13/hyde).
|
||||
|
||||
## Author(s)
|
||||
### Original Developed by Mark Otto
|
||||
|
||||
### Sidebar menu
|
||||
|
||||
Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.
|
||||
|
||||
|
||||
### 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**
|
||||
### Hugo's Hyde Ported by Steve Francia
|
||||
- <https://github.com/spf13>
|
||||
- <https://twitter.com/spf13>
|
||||
|
||||
### Color Theme Inspired By
|
||||
|
||||
* [Nate Finch's blog](https://npf.io)
|
||||
|
||||
## License
|
||||
|
||||
Open sourced under the [MIT license](LICENSE.md).
|
||||
|
||||
<3
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue