diff options
| -rw-r--r-- | README.md | 35 | ||||
| -rw-r--r-- | exampleSite/config.yml | 21 | ||||
| -rw-r--r-- | images/highlight.png | bin | 96928 -> 72664 bytes | |||
| -rw-r--r-- | layouts/index.html | 3 | ||||
| -rw-r--r-- | layouts/partials/custom/homepage-summary.html | 8 | ||||
| -rw-r--r-- | layouts/partials/footer.html | 9 | ||||
| -rw-r--r-- | layouts/partials/header.html | 7 | ||||
| -rw-r--r-- | layouts/partials/meta.html | 6 |
8 files changed, 73 insertions, 16 deletions
@@ -2,11 +2,11 @@ <p align="center"><a href="https://github.com/mistermantas/cstate/releases"><img src="https://img.shields.io/github/release/mistermantas/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/mistermantas/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/mistermantas/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/mistermantas/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/mistermantas/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://gitter.im/cState/Lobby"><img src="https://img.shields.io/badge/chat-gitter-ed1965.svg?style=flat-square" alt="Gitter" /></a> <a href="https://twitter.com/mistermantas"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&label=Follow" alt="Twitter" /></a></p> -> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Compatible with Netlify & GitHub Pages. +> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely free with Netlify & GitHub Pages. -*This release is a developer preview.* +[**Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com) -[**Live demo**](https://themes.gohugo.io/theme/cstate/) +*Looking for contributors! See Contribute section:* ## Contents @@ -14,11 +14,13 @@ + Getting started + [Production](#production) + [Development](#development) - + [Updating](#updating) ++ [Updating](#updating) + [FAQ](#faq) + [Contribute](#contribute) + [License](#license) +*** + ## Features + Built with [Hugo](https://gohugo.io), a hyperfast Golang generator @@ -33,7 +35,7 @@ For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`). -#### Production (with Netlify) +#### Production We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings: @@ -41,7 +43,9 @@ We encourage you to use [Netlify](https://www.netlify.com) for cState. These are + Publish directory: **public** + Add one build environment variable + Key: **HUGO_VERSION** - + Value: **0.31** + + Value: **0.41** + +*** 1. Download the contents of the `exampleSite` directory in this repository. This will be your site guts, which will hold the content and configuration for the status page. 2. Create a `themes` folder and navigate to it on the command line. @@ -56,7 +60,7 @@ mkdir themes; cd themes; git submodule add https://github.com/mistermantas/cstate ``` -4. Set up cState for your liking. It is now ready to be deployed +4. Set up cState for your liking. It is now ready to be used in production. #### Development @@ -75,10 +79,16 @@ cd cstate-master/exampleSite 3. Uncomment this line in `config.yml`: ```yml -# themesDir: ../.. +themesDir: ../.. ``` -3. Then try out the site! A link to it will be shown on screen. +4. Make sure that the folder name is the same as the `theme` value:d + +```yml +theme: cstate-master +``` + +5. Then try out the site! A link to it will be shown on screen. ```bash hugo serve @@ -114,9 +124,9 @@ Affected: Section: post --- -*Monitoring* - After hitting the ole reboot button Example Chat App is now recovering. We're going to continue to monitor as everyone reconnects. {{< track "2018-04-13 16:50:00" >}} +*Monitoring* - After hitting the ole reboot button Example Chat App is now recovering. We’re going to continue to monitor as everyone reconnects. {{< track "2018-04-13 16:50:00" >}} -*Investigating* - We're aware of users experiencing unavailable guilds and issues when attempting to connect. We're currently investigating. {{< track "2018-04-13 15:54:00" >}} +*Investigating* - We’re aware of users experiencing unavailable guilds and issues when attempting to connect. We're currently investigating. {{< track "2018-04-13 15:54:00" >}} ``` Time to break that down. @@ -131,10 +141,13 @@ Time to break that down. ## Contribute +cState needs help to grow, not only would it benefit from stuff like unit tests, but also get influenced by fresh ideas to grow even further. + + Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md). + Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/mistermantas/cstate/issues). + Write consistent, simple, readable code and precise documentation. + [Join the Gitter chat](http://discord.io/choraleapp) for help or discussion. ++ You may also the creator’s [mnts Discord](https://discord.gg/EvQZdhT). ## License diff --git a/exampleSite/config.yml b/exampleSite/config.yml index c75c9b6..6bd09b9 100644 --- a/exampleSite/config.yml +++ b/exampleSite/config.yml @@ -6,6 +6,13 @@ # Welcome to the cState configuration file! # +# This is the configuration file for v2-rc1. +# If you are using an earlier version, or one +# in the future, such as v3, you may see errors +# pop up when deploying a cState website. +# +# Now, onto the fun part. +# # Hugo is used for building the status page, # so this file can be used to change how # your status page should behave or look. @@ -37,7 +44,7 @@ # What is your status page called? # Shows up in the browser bar and meta tags -title: Example Status +title: cState Status # What language is this page in? # Only alters the html[lang] attribute @@ -72,7 +79,7 @@ params: description: The guts of the application. - name: Media Proxy - description: This is the service responsible for serving images, audio, and video. It is reliant on Fastly. + description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN. # partial: custom/metrics # What header design should we use? @@ -180,10 +187,18 @@ buildFuture: true # These options affect the core of cState. # Please do not change them if you do not # know what you are doing. -theme: cstate-dev +theme: cstate-master # If you are developing locally and want # to contribute to the cState Git repo, # please uncomment this option but do not # forget to re-comment it when themesDir: ../.. + +# This option tells cState what version +# your config file is using. +# +# Never ever remove this, nor change it, +# if you have not updated to any other +# version. +version: 2 diff --git a/images/highlight.png b/images/highlight.png Binary files differindex 19dc9b2..a16c9ef 100644 --- a/images/highlight.png +++ b/images/highlight.png diff --git a/layouts/index.html b/layouts/index.html index f80dfe0..b937777 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -97,6 +97,9 @@ {{ end }} </div> + {{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/homepage-summary" . }} + {{ end }} <!-- End main --> </div> diff --git a/layouts/partials/custom/homepage-summary.html b/layouts/partials/custom/homepage-summary.html new file mode 100644 index 0000000..1dadab6 --- /dev/null +++ b/layouts/partials/custom/homepage-summary.html @@ -0,0 +1,8 @@ +<!-- + +This file can be used to add custom HTML +to your cState powered status page. + +https://github.com/mistermantas/cstate/wiki/Customization + +--> diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index d6b5486..f9c49d8 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -1,3 +1,6 @@ +{{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/above-footer" . }} +{{ end }} <div class="footer"> <div class="contain"> @@ -8,6 +11,10 @@ <p>{{ .Site.Params.description }}</p> <!-- Please keep this one around to help cState grow <3 --> - <small class="copyright faded">Powered by <a href="https://github.com/mistermantas/cstate">cState</a></small> + <small class="copyright faded">Powered by <a href="https://github.com/mistermantas/cstate">cState <b>v2.0-rc1</b></a></small> </div> </div> + +{{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/below-footer" . }} +{{ end }} diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 94bef80..cfe6109 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -1,3 +1,6 @@ +{{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/above-header" . }} +{{ end }} {{ if .Site.Params.useLargeHeaderDesign }} <div class="header header--large"> @@ -24,3 +27,7 @@ </div> </div> {{ end }} + +{{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/below-header" . }} +{{ end }} diff --git a/layouts/partials/meta.html b/layouts/partials/meta.html index 7b45778..b5b7568 100644 --- a/layouts/partials/meta.html +++ b/layouts/partials/meta.html @@ -45,6 +45,8 @@ box-sizing: inherit; } + ::selection { background: #B4D5FF; } + hr { border: 0; border-bottom: 1px solid #ccc; @@ -280,5 +282,7 @@ } } </style> - + {{ if .Site.Params.enableCustomHTML }} + {{ partial "custom/meta" . }} + {{ end }} </head> |
