Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/gonnux/hugo-apps-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d0d636a516a11496d0442df5d7b32ff87be5caa2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# Hugo Apps Theme
[![GitHub stars](https://img.shields.io/github/stars/gonnux/hugo-apps-theme.svg?style=flat-square)](https://github.com/gonnux/hugo-apps-theme/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/gonnux/hugo-apps-theme.svg?style=flat-square)](https://github.com/gonnux/hugo-apps-theme/fork)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/gonnux/hugo-apps-theme/master/LICENSE.md)

Hugo apps theme makes it easy to post web apps

## Installation
From the root of your website
```bash
mkdir -p themes
cd themes
git clone https://github.com/gonnux/hugo-apps-theme
```
From config.toml of your site
```toml
theme = "hugo-apps-theme"
```

## Creating a page
```bash
hugo new about.md
#hugo new about.html
```
```bash
hugo new apps/myapp.md
#hugo new apps/myapp.html
```
```bash
mkdir apps/myapp
touch apps/myapp/index.html
touch apps/myapp/app.js
touch apps/myapp/app.css
```

## Configuration

### Front Matter
- title(string): title for your page
- showTitle(boolean): whether you want to show the title
- weight(integer): weight of your page, used for sorting
- full(boolean): whether your page is full page or not
- enableDisqus(boolean): whether your page uses disqus or not, even though this value is true you cannot enable disqus for full page
- img(string): logo image for your page

### What is full page?
Web apps, they would probably have index.html which contains html, head, body tags<br/>
if you want to post index.html without removing that tags,<br/>
you can achieve this by setting full=true

### config.toml
- baseURL(string): base url of your site
- hasCJKLanguage(boolean): whether you support CJK language or not
- disqusShortname(string): disqus short name
- googleAnalytics(string): google analytics tracking id
- title(string): title of your site
- copyright(string): copyright of your site
- [params]googleAutoAds(string): google_ad_client value of Google Auto Ads
- [params]avatar(string): avatar image url of index page of your site
- [params]author(string): your name at index page
- [params]info(string): info string below your name at index page
- [[menu.main]]name(string): name of menu item
- [[menu.main]]url(string): url of menu item
- [[menu.main]]weight(integer): weight of menu item, used for sorting

## Features
* Responsive
* Disqus
* HighlightJS
* Google Analytics
* Open Graph

### Contribution
Fork this repository and create an PR to dev branch.

## Inspired by
This theme is inspired by following themes:<br/>
[Hugo Coder](https://github.com/luizdepra/hugo-coder)

## License
Licensed under the [MIT](https://opensource.org/licenses/MIT) License.<br/>
See the [LICENSE](https://raw.githubusercontent.com/gonnux/hugo-apps-theme/master/LICENSE.md) file for more details.