Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ typings/
# dotenv environment variables file
.env

# Mac .DS_Store files
.DS_Store
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "themes/cupper"]
path = themes/cupper
url = https://github.com/aral/cupper-hugo-theme.git
4 changes: 4 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ canonifyURLs = true
theme = "cupper"
publishDir = "docs"

# Search
[outputs]
home = [ "HTML", "RSS", "JSON" ]

[params]
description = "Documentation for the **Cupper** documentation builder, built with **Cupper** itself."
codePenUser = "Heydon"
4 changes: 2 additions & 2 deletions content/patterns/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ If you do not have a version of the Github desktop client installed, follow the

While you're in the Github interface, you might as well set up the publishing source for the live site. Choose the Master branch/docs option under **Settings → Github Pages → Source**. See {{% pattern "Serving" %}} for more details.

Once you have your local copy of the files, move to the root of that folder and in your terminal run an npm installation:
Once you have your local copy of the files, move to the root of that folder and in your terminal run the installation script:

{{<cmd>}}npm install{{</cmd>}}
{{<cmd>}}./install{{</cmd>}}

Now it's time to consult the {{% pattern "Setup" %}} pattern.
18 changes: 3 additions & 15 deletions content/patterns/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title = "Updating Cupper"
weight = 5
+++

The core of **Cupper's** functionality is in its Hugo theme, also called **Cupper**. This is found in the theme folder.
The core of **Cupper's** functionality is in its Hugo theme, called [Cupper Hugo Theme](https://github.com/aral/cupper-hugo-theme). This is installed in the theme folder when you run the installation script. You can also install it separately into any Hugo instance.

{{% fileTree %}}
* content
Expand All @@ -20,19 +20,7 @@ Do not "hack the core". If you have any issues with **Cupper**, please report th
Cupper is undergoing constant development, so keep an eye out for new releases. To update to a new version of **Cupper**, simply run the `update` command from inside your local project folder.

{{<cmd>}}
npm run update
./update
{{</cmd>}}

This will save a timestamped backup of the current version, and download the latest version. Your theme folder will now look something like the following.

{{% fileTree %}}
* themes
* cupper
* cupper-old-1503389765972
{{% /fileTree %}}

If you experience breaking changes and are having trouble fixing them, you can rename the old folder and revert to using it. In the meantime, you can [submit an issue](https://github.com/ThePacielloGroup/cupper/issues) with the "help" tag describing your problem.

{{% warning %}}
The described update process relies on SVN because Github does not support downloading individual repository folders. If you have a Mac, SVN should be installed already. If not, or if you are on Windows, you can either install SVN or download the latest [**Cupper** theme folder](https://github.com/ThePacielloGroup/cupper/tree/master/themes/cupper) manually, using the Github web interface.
{{% /warning %}}
This will update the Cupper Hugo Theme to its latest version.
22 changes: 22 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">

<link rel="canonical" href="">
<link rel="apple-touch-icon" sizes="57x57" href="https://thepaciellogroup.github.io/cupper/images/apple-touch-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="https://thepaciellogroup.github.io/cupper/images/apple-touch-icon-60x60.png">
Expand All @@ -22,8 +23,10 @@
<meta name="msapplication-TileImage" content="https://thepaciellogroup.github.io/cupper/images/ms-icon-144x144.png">
<meta name="theme-color" content="#ffffff">
<link href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" rel="stylesheet" media="none" onload="this.media='all';">
<link href="https://thepaciellogroup.github.io/cupper/css/auto-complete.css?1514235221" rel="stylesheet">
<link rel="stylesheet" href="https://thepaciellogroup.github.io/cupper/css/prism.css" media="none" onload="this.media='all';">
<link rel="stylesheet" type="text/css" href="https://thepaciellogroup.github.io/cupper/css/styles.css">
<script src="https://thepaciellogroup.github.io/cupper/js/jquery-2.x.min.js?1514235221"></script>
<style id="inverter" media="none">
html { filter: invert(100%) }
* { background-color: inherit }
Expand Down Expand Up @@ -148,6 +151,25 @@
</p>

</div>


<div class="searchbox">
<label for="search-by"><i class="fa fa-search"></i></label>
<input data-search-input id="search-by" type="text" placeholder="">
<span data-search-clear=""><i class="fa fa-close"></i></span>
</div>

<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/lunr.min.js?1514235221"></script>
<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/auto-complete.js?1514235221"></script>
<script type="text/javascript">

var baseurl = "https:\/\/thepaciellogroup.github.io\/cupper\/";

</script>
<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/search.js?1514235221"></script>




<nav id="patterns-nav" class="patterns" role="navigation">
<h2 class="vh">Main navigation</h2>
Expand Down
14 changes: 0 additions & 14 deletions docs/categories/index.xml

This file was deleted.

47 changes: 47 additions & 0 deletions docs/css/auto-complete.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.autocomplete-suggestions {
text-align: left;
cursor: default;
border: 1px solid #ccc;
border-top: 0;
background: #fff;
box-shadow: -1px 1px 3px rgba(0,0,0,.1);

/* core styles should not be changed */
position: absolute;
display: none;
z-index: 9999;
max-height: 254px;
overflow: hidden;
overflow-y: auto;
box-sizing: border-box;

}
.autocomplete-suggestion {
position: relative;
cursor: pointer;
padding: 7px;
line-height: 23px;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
color: #333;
}

.autocomplete-suggestion b {
font-weight: normal;
color: #1f8dd6;
}

.autocomplete-suggestion.selected {
background: #333;
color: #fff;
}

.autocomplete-suggestion:hover {
background: #444;
color: #fff;
}

.autocomplete-suggestion > .context {
font-size: 12px;
}
3 changes: 3 additions & 0 deletions docs/css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,9 @@ h1 svg {
.intro {
text-align: center;
}
.intro-and-nav {
border-right: none;
}
.intro-and-nav > div {
padding: 1.5rem;
}
Expand Down
24 changes: 23 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="Hugo 0.22.1" />
<meta name="generator" content="Hugo 0.31.1" />
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">

<link rel="canonical" href="https://thepaciellogroup.github.io/cupper/">
<link rel="apple-touch-icon" sizes="57x57" href="https://thepaciellogroup.github.io/cupper/images/apple-touch-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="https://thepaciellogroup.github.io/cupper/images/apple-touch-icon-60x60.png">
Expand All @@ -23,8 +24,10 @@
<meta name="msapplication-TileImage" content="https://thepaciellogroup.github.io/cupper/images/ms-icon-144x144.png">
<meta name="theme-color" content="#ffffff">
<link href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" rel="stylesheet" media="none" onload="this.media='all';">
<link href="https://thepaciellogroup.github.io/cupper/css/auto-complete.css?1514235221" rel="stylesheet">
<link rel="stylesheet" href="https://thepaciellogroup.github.io/cupper/css/prism.css" media="none" onload="this.media='all';">
<link rel="stylesheet" type="text/css" href="https://thepaciellogroup.github.io/cupper/css/styles.css">
<script src="https://thepaciellogroup.github.io/cupper/js/jquery-2.x.min.js?1514235221"></script>
<style id="inverter" media="none">
html { filter: invert(100%) }
* { background-color: inherit }
Expand Down Expand Up @@ -151,6 +154,25 @@
</p>

</div>


<div class="searchbox">
<label for="search-by"><i class="fa fa-search"></i></label>
<input data-search-input id="search-by" type="text" placeholder="">
<span data-search-clear=""><i class="fa fa-close"></i></span>
</div>

<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/lunr.min.js?1514235221"></script>
<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/auto-complete.js?1514235221"></script>
<script type="text/javascript">

var baseurl = "https:\/\/thepaciellogroup.github.io\/cupper\/";

</script>
<script type="text/javascript" src="https://thepaciellogroup.github.io/cupper/js/search.js?1514235221"></script>




<nav id="patterns-nav" class="patterns" role="navigation">
<h2 class="vh">Main navigation</h2>
Expand Down
Loading