Skip to content

Commit

Permalink
New web page docs
Browse files Browse the repository at this point in the history
  • Loading branch information
syn-4ck committed May 14, 2023
1 parent 5c4fae6 commit d482ba8
Show file tree
Hide file tree
Showing 57 changed files with 2,283 additions and 10,452 deletions.
6 changes: 6 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Not Found
description: This does not exist
permalink: /404.html
sitemap: false
---
11 changes: 11 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
source 'https://rubygems.org'

gem 'jekyll', '~> 4.2.0'

group :jekyll_plugins do
gem 'jekyll-archives', '~> 2.2.1'
gem 'jekyll-feed', '~> 0.15.1'
gem 'jekyll-paginate', '~> 1.1.0'
gem 'jekyll-seo-tag', '~> 2.7.1'
gem 'jekyll-sitemap', '~> 1.4.0'
end
81 changes: 81 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.9)
em-websocket (0.5.2)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.15.1)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (1.8.10)
concurrent-ruby (~> 1.0)
jekyll (4.2.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-archives (2.2.1)
jekyll (>= 3.6, < 5.0)
jekyll-feed (0.15.1)
jekyll (>= 3.7, < 5.0)
jekyll-paginate (1.1.0)
jekyll-sass-converter (2.1.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.7.1)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.3.1)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.5.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.6)
rb-fsevent (0.11.0)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.26.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.7.0)

PLATFORMS
ruby

DEPENDENCIES
jekyll (~> 4.2.0)
jekyll-archives (~> 2.2.1)
jekyll-feed (~> 0.15.1)
jekyll-paginate (~> 1.1.0)
jekyll-seo-tag (~> 2.7.1)
jekyll-sitemap (~> 1.4.0)

BUNDLED WITH
1.17.3
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2016-2020 CloudCannon

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.
80 changes: 80 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Hydra

Marketing site template for Jekyll. Browse through a [live demo](https://proud-alligator.cloudvent.net/).
Increase the web presence of your brand with this configurable theme.

![Hydra template screenshot](images/_screenshot.png)

Hydra was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at [CloudCannon Academy](https://learn.cloudcannon.com/).

[![Deploy to CloudCannon](https://buttons.cloudcannon.com/deploy.svg)](https://app.cloudcannon.com/register#sites/connect/github/CloudCannon/hydra-jekyll-template)

## Features

* Contact form
* Pre-built pages
* Pre-styled components
* Blog with pagination
* Post category pages
* Disqus comments for posts
* Staff and author system
* Configurable footer
* Optimised for editing in [CloudCannon](http://cloudcannon.com/)
* RSS/Atom feed
* SEO tags
* Google Analytics

## Setup

1. Add your site and author details in `_config.yml`.
2. Add your Google Analytics and Disqus keys to `_config.yml`.
3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).

## Develop

Hydra was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well.

Install the dependencies with [Bundler](http://bundler.io/):

~~~bash
$ bundle install
~~~

Run `jekyll` commands through Bundler to ensure you're using the right versions:

~~~bash
$ bundle exec jekyll serve
~~~

## Editing

Hydra is already optimised for adding, updating and removing pages, staff, advice, company details and footer elements in CloudCannon.

### Posts

* Add, update or remove a post in the *Posts* collection.
* The **Staff Author** field links to members in the **Staff** collection.
* Documentation pages are organised in the navigation by category, with URLs based on the path inside the `_docs` folder.
* Change the defaults when new posts are created in `_posts/_defaults.md`.

### Contact Form

* Preconfigured to work with CloudCannon, but easily changed to another provider (e.g. [FormSpree](https://formspree.io/)).
* Sends email to the address listed in company details.

### Staff

* Reused around the site to save multiple editing locations.
* Add `excluded_in_search: true` to any documentation page's front matter to exclude that page in the search results.

### Navigation

* Exposed as a data file to give clients better access.
* Set in the *Data* / *Navigation* section.

### Footer

* Exposed as a data file to give clients better access.
* Set in the *Data* / *Footer* section.
92 changes: 92 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# ----
# Site

title: pynipper-ng official web page
url: "https://syn-4ck.github.io/pynipper-ng"
baseurl:
google_analytics_key:
google_maps_javascript_api_key:
disqus_shortname:

# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
logo: /siteicon.png
description: Configuration security analyzer for network devices.
author:
name: syn-4ck
email: repoJFM@protonmail.com
twitter: syn-4ck
social:
name: GitHub
links:
- https://github.com/syn-4ck

# -----
# Build

timezone: Etc/UTC

collections:
staff_members:
_hide_content: true

paginate: 10
paginate_path: "/blog/:num/"
permalink: pretty

defaults:
- scope:
path: ""
type: "posts"
values:
layout: "post"
_options:
content:
width: 1500
height: 2500
- scope:
path: ""
type: "staff_members"
values:
_options:
image_path:
width: 600
height: 600
- scope:
path: ""
values:
layout: "page"
- scope:
path: "index.html"
values:
layout: "default"
- scope:
path: "contact.html"
values:
full_width: true

jekyll-archives:
enabled:
- categories

plugins:
- jekyll-archives
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-feed
- jekyll-paginate

exclude:
- Gemfile
- Gemfile.lock
- README.md
- LICENCE

_comments:
map: Update the map location and display settings.
latitude: Coordinates for the center marker on the map.
longitude: Coordinates for the center marker on the map.
zoom: The zoom level for the map.
pricing_table: Update the information in the pricing tables.
highlight: Emphasis the text
color: The background colour used in the plan name and call to action.
new_window: Open link in new window
39 changes: 39 additions & 0 deletions _data/footer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- links:
- name: Pricing
link: /pricing/
- name: Blog
link: /blog/
- name: About
link: /about/
- name: Contact
link: /contact/
- links:
- name: Login
link: /
new_window: true
- name: Sign Up
link: /
new_window: true
- name: Docs
link: /
new_window: true
- name: Status
link: /
new_window: true
- links:
- name: Facebook
link: https://facebook.com/cloudcannon/
new_window: true
social_icon: Facebook
- name: Twitter
link: https://twitter.com/cloudcannon/
social_icon: Twitter
new_window: true
- name: YouTube
link: https://youtube.com/cloudcannon/
social_icon: YouTube
new_window: true
- name: RSS
link: /feed.xml
social_icon: RSS
new_window: false
16 changes: 16 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
- name: Documentation
link: https://pynipper-ng.readthedocs.io/
new_window: true
highlight: false
- name: Blog and news
link: /blog/
new_window: false
highlight: false
- name: About
link: /about/
new_window: false
highlight: false
- name: Contact
link: /contact/
new_window: false
highlight: false
10 changes: 10 additions & 0 deletions _includes/list-posts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{% for post in include.posts %}
<li class="blog-post">
<h3><a href="{% include relative-src.html src=post.url %}">{{ post.title }}</a></h3>
{% include post-title.html post=post %}
<div class="post-content">
{{ post.excerpt }}
<div class="button"><a href="{% include relative-src.html src=post.url %}">Read More</a></div>
</div>
</li>
{% endfor %}
15 changes: 15 additions & 0 deletions _includes/navigation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<nav>
<a class="nav-toggle" id="open-nav" href="#">&#9776;</a>
<a class="editor-link btn" href="cloudcannon:collections/_data/navigation.yml" class="btn"><strong>&#9998;</strong> Edit navigation</a>
{% for link in site.data.navigation %}
{% assign class = "" %}
{% if link.highlight %}
{% assign class = class | append: " highlight" %}
{% endif %}

{% if link.link == page.url %}
{% assign class = class | append: " active" %}
{% endif %}
<a href="{% include relative-src.html src=link.link %}" class="{{ class }}" {% if link.new_window %}target="_blank"{% endif %}>{{ link.name }}</a>
{% endfor %}
</nav>
8 changes: 8 additions & 0 deletions _includes/post-title.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<p class="post-details">
{% for category in include.post.categories %}
<span class="blog-filter">
<a href="{{ site.baseurl }}/category/{{ category | slugify }}/">{{ category | capitalize }}</a>
</span>
{% endfor %}
<span class="post-date">{{ include.post.date | date: "%B %d, %Y" }}</span>
</p>
1 change: 1 addition & 0 deletions _includes/relative-src.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% assign prefix = include.src | slice: 0, 2 %}{% assign protocol = include.src | slice: 0, 4 %}{% unless protocol == 'http' or prefix == "//" %}{{ site.baseurl }}{% endunless %}{{ include.src }}
Loading

0 comments on commit d482ba8

Please sign in to comment.