Browse Source

rewrote readme

main
gryffyn 9 months ago
parent
commit
c4729774c1
Signed by: gryffyn GPG Key ID: 6948DD6514D02BEF
  1. 28
      README.md
  2. 12
      makefile
  3. 31
      netlify.toml
  4. 22
      theme.toml

28
README.md

@ -1,20 +1,13 @@
# Hugo Theme: Console
# Hugo Theme: Console-Dark
A minimal, responsive and light theme for Hugo inspired by Linux console.
![Console](https://github.com/mrmierzejewski/hugo-theme-console/blob/master/images/preview.png?raw=true)
## Live demo
* https://mrmierzejewski.com
* https://themes.gohugo.io/theme/hugo-theme-console/
A minimal, responsive and light theme for Hugo inspired by Linux console, now with grey and pink! Fork of [hugo-theme-console](https://github.com/mrmierzejewski/hugo-theme-console).
## Installation
```sh
$ mkdir themes
$ cd themes
$ git submodule add https://github.com/mrmierzejewski/hugo-theme-console.git hugo-theme-console
$ git submodule add https://github.com/gryffyn/hugo-theme-console-dark.git hugo-theme-console-dark
```
See the [Hugo documentation](https://gohugo.io/themes/installing/) for more information.
@ -24,15 +17,7 @@ See the [Hugo documentation](https://gohugo.io/themes/installing/) for more info
Set theme parameter in your config file:
```
theme = "hugo-theme-console"
```
## Example Site
To run the example site, please type the following command:
```
makefile hugo-server
theme: "hugo-theme-console-dark"
```
### Start page
@ -42,6 +27,7 @@ your website top-level ```layouts``` folder (```layouts/index.html```).
## License
Copyright © 2020 [Marcin Mierzejewski](https://mrmierzejewski.com/)
Copyright © 2021 [gryffyn](https://github.com/gryffyn)
The theme is released under the MIT License. Check the [original theme license](https://github.com/panr/hugo-theme-terminal/blob/master/LICENSE.md) for additional licensing information.
The theme is released under the MIT License.
Check the [original theme license](https://github.com/mrmierzejewski/hugo-theme-console/blob/master/LICENSE) for additional licensing information.

12
makefile

@ -1,12 +0,0 @@
PWD ?= $(shell pwd)/
usage: ### Usage (default)
@echo
@echo "USAGE:"
@echo " make command [options]"
@echo
@echo "COMMANDS:"
@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed 's/^/ /' | sed -e 's/\\$$//' | sed -e 's/#/ /g'
hugo-server: ## Run Hugo web server and serve the example site
cd exampleSite; hugo server --cleanDestinationDir --themesDir ../../ -t hugo-theme-console

31
netlify.toml

@ -1,31 +0,0 @@
[build]
base = "exampleSite"
publish = "public"
command = "hugo --gc --minify --themesDir ../../ -t repo -b $URL"
[context.production.environment]
HUGO_VERSION = "0.76.3"
HUGO_ENV = "production"
HUGO_ENABLEGITINFO = "true"
[context.split1]
command = "hugo --gc --minify --enableGitInfo -b $DEPLOY_PRIME_URL --themesDir ../../ -t repo"
[context.split1.environment]
HUGO_VERSION = "0.76.3"
HUGO_ENV = "production"
[context.deploy-preview]
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL --themesDir ../../ -t repo"
[context.deploy-preview.environment]
HUGO_VERSION = "0.76.3"
[context.branch-deploy]
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL --themesDir ../../ -t repo"
[context.branch-deploy.environment]
HUGO_VERSION = "0.76.3"
[context.next.environment]
HUGO_ENABLEGITINFO = "true"

22
theme.toml

@ -1,18 +1,18 @@
name = "hugo-theme-console"
name = "hugo-theme-console-dark"
license = "MIT"
licenselink = "https://github.com/mrmierzejewski/hugo-theme-console/blob/master/LICENSE"
description = "A minimal, responsive and light theme for Hugo inspired by Linux console."
homepage = "https://github.com/mrmierzejewski/hugo-theme-console"
tags = ["blog", "gallery", "portfolio", "console", "terminal", "clean", "personal", "minimal", "monotone", "simple", "technical", "responsive", "mobile", "minimalist", "retro", "animation"]
features = ["disqus", "responsive", "google analytics"]
licenselink = "https://github.com/gryffyn/hugo-theme-console-dark/blob/master/LICENSE"
description = "A minimal, responsive and light theme for Hugo inspired by Linux console, now with grey and pink! Fork of hugo-theme-console."
homepage = "https://github.com/gryffyn/hugo-theme-console-dark"
tags = ["blog", "portfolio", "console", "terminal", "clean", "personal", "minimal", "monotone", "simple", "technical", "responsive", "mobile", "minimalist", "retro"]
features = ["responsive"]
min_version = "0.69.0"
[author]
name = "Lily Sinclair"
homepage = "https://neveris.one"
github = "https://github.com/gryffyn"
[original]
name = "Marcin Mierzejewski"
homepage = "https://mrmierzejewski.com"
github = "https://github.com/mrmierzejewski"
[original]
author = "Jonas D."
homepage = "https://terminalcss.xyz/"
repo = "https://github.com/Gioni06/terminal.css"

Loading…
Cancel
Save