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

github.com/zwbetz-gh/papercss-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZachary Betz <zwbetz@gmail.com>2019-02-22 00:42:18 +0300
committerZachary Betz <zwbetz@gmail.com>2019-02-22 00:42:18 +0300
commit1695245874d929a038292fc40f2e86988a82a082 (patch)
treeeb10ad1f300de16b0638210e7b6c582f33fe8dd9
Initial commit
-rw-r--r--.gitignore1
-rw-r--r--LICENSE21
-rw-r--r--README.md71
-rw-r--r--netlify.toml8
-rw-r--r--theme.toml12
5 files changed, 113 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..73eae91
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+exampleSite/public/ \ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..31647fb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Zachary Betz
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8de34b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+# Cupper
+
+TODO netlify status
+
+TODO description
+
+## Table of contents
+
+- [Demo](#demo)
+- [Minimum Hugo version](#minimum-hugo-version)
+- [Installation](#installation)
+- [Updating](#updating)
+- [Run example site](#run-example-site)
+- [Configuration](#configuration)
+- [Favicons](#favicons)
+- [Shortcodes](#shortcodes)
+- [Getting help](#getting-help)
+- [Credits](#credits)
+
+## Demo
+
+https://paper-hugo-theme.netlify.com/
+
+## Minimum Hugo version
+
+Hugo version `0.48` or higher is required. View the [Hugo releases](https://github.com/gohugoio/hugo/releases) and download the binary for your OS.
+
+## Installation
+
+From the root of your site:
+
+```
+git submodule add https://github.com/zwbetz-gh/paper-hugo-theme.git themes/paper-hugo-theme
+```
+
+## Updating
+
+From the root of your site:
+
+```
+git submodule update --remote --merge
+```
+
+## Run example site
+
+From the root of `themes/paper-hugo-theme/exampleSite`:
+
+```
+hugo server --themesDir ../..
+```
+
+## Configuration
+
+Copy the `config.toml` or `config.yaml` from the exampleSite TODO, then edit as desired.
+
+## Favicons
+
+Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`.
+
+## Shortcodes
+
+TODO link
+
+
+## Getting help
+
+If you run into an issue that isn't answered by this documentation or the exampleSite TODO, then visit the [Hugo forum](https://discourse.gohugo.io/). The folks there are helpful and friendly. **Before** asking your question, be sure to read the [requesting help guidelines](https://discourse.gohugo.io/t/requesting-help/9132). Feel free to tag me in your question, my forum username is [@zwbetz](https://discourse.gohugo.io/u/zwbetz/summary).
+
+## Credits
+
+TODO credits \ No newline at end of file
diff --git a/netlify.toml b/netlify.toml
new file mode 100644
index 0000000..e1631a1
--- /dev/null
+++ b/netlify.toml
@@ -0,0 +1,8 @@
+[build]
+ publish = "exampleSite/public"
+ command = "cd exampleSite && hugo --gc --themesDir ../.."
+
+[build.environment]
+ HUGO_VERSION = "0.54.0"
+ HUGO_THEME = "repo"
+ HUGO_BASEURL = "https://paper-hugo-theme.netlify.com/" \ No newline at end of file
diff --git a/theme.toml b/theme.toml
new file mode 100644
index 0000000..fb0950e
--- /dev/null
+++ b/theme.toml
@@ -0,0 +1,12 @@
+name = "PaperCSS"
+license = "MIT"
+licenselink = "https://github.com/zwbetz-gh/paper-hugo-theme/blob/master/LICENSE"
+description = "TODO"
+homepage = "https://github.com/zwbetz-gh/paper-hugo-theme"
+tags = ["TODO"]
+features = ["TODO"]
+min_version = "0.48"
+
+[author]
+ name = "Zachary Betz"
+ homepage = "https://zwbetz.com/"