swiftfire-jekyll-theme 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41e2db541ff87d0ccb16c807d3a5295e32ca5f9c064da02b07fadacad3b787b9
+  data.tar.gz: 0bfff5270bab046ef9bb321655ad1accebc45eca5a9ba7cbfbe6bc24e20a3d4c
+SHA512:
+  metadata.gz: 1e8440de3f960b712043abc06a405969dda6b8200a7fc58561fec53eaf91d47f555ded9f474a73353de8ea06bb60081dbe0714bda6c6674e3811c4a5da9a31e1
+  data.tar.gz: c418a7f59bd8b7f46a4875b5414c01c505f601f8f01170403b05cf509fe3c6dacc87df874072985c78820b4c619f762540c66bdd6e0b92b8145709a0d877674e

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rien van der Lugt
+
+For the cookie warning: Copyright (c) 2015 Silktide Ltd
+
+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.

data/README.md

@@ -0,0 +1,107 @@
+# Swiftfire-Jekyll-Theme v0.1.0
+
+Welcome to Swiftfire-Jekyll-Theme. This theme extends the Classic-Jekyll-Theme with a comment system that allows readers to comment on articles blogs etc. This includes a registration system and login/logout system.
+
+WARNING: This theme requires the Swiftfire webserver. It will not work without this server. Specifically don't bother installing it on github and don't bother using any other webserver. That simply will not work, is not supported and will never be supported (by us).
+
+On the plus side, the Swiftfire webserver is free and open source. You will need a macOS system to deploy it though.
+
+You do not need the Classic-Jekyll-Theme, it is entirely included in this theme.
+
+Like the Classic-Jekyll-Theme this theme centers around one of the most used website structures on the web. A banner, navigation menu (dropdown), (up to) three columns and a footer. The design is fully responsive for three different screen widths: widest, medium and narrow. It is probably best shown in an example:
+
+Widest:
+
+![wide-layout](http://balancingrock.nl/assets/img/classic-jekyll-theme-wide.png)
+
+Medium:
+
+![medium-left-layout](http://balancingrock.nl/assets/img/classic-jekyll-theme-medium-left.png)
+
+Narrow:
+
+![narrow-layout](http://balancingrock.nl/assets/img/classic-jekyll-theme-narrow.png)
+
+The columns are called Primary (blue), Secondary (grey) and Tertiary (pink). In the above layouts the secondary column is on the left side. If it had been on the right side, the medium layout would have looked like this:
+
+![medium-right-layout](http://balancingrock.nl/assets/img/classic-jekyll-theme-medium-right.png)
+
+The menu bar (in yellow) is always deployed in the wide layout. In the medium and narrow layout the menu bar is shown in the deployed state. When not deployed, a menu-item symbol is shown in the banner that switches the menu between deployed and not.
+
+An example screenshot:
+
+![example](http://balancingrock.nl/assets/img/classic-jekyll-theme-screenshot-half.png)
+
+
+Features shared with the Classic-Jekyll-Theme:
+
+- __Secondary and Tertiary Columns__ can be specified by default and on a page by page basis for presence, location and content.
+
+- __Navigation bar with drop-down menu__ is created automatically from the available pages when these have the proper YAML frontmatter. The navigation bar contains the top level menu items, while the submenu items show up as a drop-down menu when the cursor hovers over the corresponding menu item. Hovering over submenu item brings up the sub-submenu items.
+
+- __Create the menu__ from either Posts and/or Pages.
+
+- __Category pages__ are created semi-automatically; the web designer has to identify the categories for inclusion, but the menu entry and category pages are created automatically.
+
+- __Cookies policy__ for european users is included by default. It can be easily disabled for non-european websites.
+
+- __Language customization__ (not multi-language support!).
+
+- __Icon__ support for an icon in the upper left corner of the site and/or in the menubar.
+
+- __Background images__ and __Background color__ settings for nearly all site elements.
+
+- __Widgets__ the following widgets are included:
+	- recent-posts: Shows a list of the N most recent posts (N is configurable).
+	- social-media: Shows a list of social media sites with their links (Edit to add).
+	- subscribe: Shows how a visitor can subscribe to your site (Edit to add).
+	- youtube-player: Shows a youtube player that scales with the column it is used in (video id parameter).
+
+- __Normalize.css__ [`normalize.css`](https://necolas.github.io/normalize.css/) is used directly instead of through the Jekyll adaptation. This allows for faster upgrade cycles.
+
+- __Excerpt on pages__ Pages defining an explicit "excerpt" in their YAML will use this as the description for the header description meta tag (necessary for SEO purposes). Note that Jekyll does not generate excerpt information for pages, only posts. Hence it is necessary to define the excerpt as a YAML tag.
+
+- __Blocked layout support__ Styles and includes support the creation of blocked layout (like product pages). To see an example of blocked pages, see the [http://balancingrock.nl](http://balancingrock.nl/classic) home page.
+
+- __Enable/disable banner__ The banner at the top of the page can be disabled.
+
+- __Move banner/menu to main column__ The banner & navigation can be moved to within the main column only. The secondary and tertiary columns will then run right up to the top of the screen.
+
+- __Pin banner__ The banner area can be pinned (fixed) to the top of the browser window.
+
+- __Split files for the menus__ It is possible to generate the menu file separate from the content file. While this may slow down the loading of the site a little, it is a huge speed up for site generation under Jekyll.
+
+Swiftfire-Jekyll-Theme improves on Classic-Jekyll-Theme with the following features:
+
+- __Commenting__ A comment section can be added to posts or pages with the swiftfire function `commentSection`
+
+- __Registration__ The ability for site visitors to register with the website, including mail confirmation. For mail confirmation the mail application `postfix` must be installed and active on the server.
+
+You can download this theme from [github](https://github.com/Balancingrock/swiftfire-jekyll-theme) or install it with [rubygems](https://rubygems.org/gems/swiftfire-jekyll-theme).
+
+Like to help out?
+
+You can support further development of this theme, or just say 'thank you' via paypal by donating to sales@balancingrock.nl or wire bitcoins to address: 1GacSREBxPy1yskLMc9de2nofNv2SNdwqH
+
+Suggested donation for personal websites is the price of a good cup of coffee: $4
+
+Suggested donation for commercial sites is the price of a good meal: $20
+
+Contract support for this (or other Jekyll related work) is available: sales@balancingrock.nl
+
+## Usage
+
+Please see [http://balancingrock.github.io/swiftfire-jekyll-theme](http://balancingrock.github.io/swiftfire-jekyll-theme) on how to use the theme and which frontmatter is available.
+
+## History
+
+- Release 0.1.0 (2020-06-12)
+
+## Suport & Feedback
+
+Comments, bug reports, feature requests and improvements are eagerly anticipated via email: rien@balancingrock.nl or via [github](http://balancingrock.github.io/swiftfire-jekyll-theme).
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/_data/cblocks.yml

@@ -0,0 +1,31 @@
+# Content blocks example
+
+- name: SwifterLog
+  description: A logging framewrok with 5 logging destinations.
+  link: https://github.com/Balancingrock/SwifterLog
+  image: http://balancingrock.nl/assets/img/swift-code-icon.png
+  
+- name: SwifterJSON
+  description: An easy to use single class JSON framework.
+  link: https://github.com/Balancingrock/SwifterJSON
+  image: http://balancingrock.nl/assets/img/swift-code-icon.png
+  
+- name: SwifterSockets
+  description: An API for POSIX sockets based networking software.
+  link: https://github.com/Balancingrock/SwifterSockets
+  image: http://balancingrock.nl/assets/img/swift-code-icon.png
+
+- name: SecureSockets
+  description: An API for OpenSSL based networking software.
+  link: https://github.com/Balancingrock/SecureSockets
+  image: http://balancingrock.nl/assets/img/swift-code-icon.png
+    
+- name: Swiftfire
+  description: An HTML server in Swift.
+  link: http://swiftfire.nl/
+  image: http://balancingrock.nl/assets/img/swift-code-icon.png
+
+- name: Classic Jekyll Theme
+  description: A theme for the Jekyll website builder.
+  link: http://balancingrock.nl/classic-jekyll-theme
+  image: http://balancingrock.nl/assets/img/classic-jekyll-theme-icon.png

data/_data/setup.yml

@@ -0,0 +1,135 @@
+# Classic Jekyll Theme settings
+
+# Classic uses three columns Primary, Secondary and Tertiary.
+# The primary column is always present and cannot be manipulated.
+# The secondary column is optional and is either to the left or to the right of the primary.
+# The tertiary column is optional and if present will be opposite the secondary column in the wide display and below the secondary in the medium display.
+# In the narrow display all three columns will be below each other (if present)
+# If the tertiary column is used, the secondary column *must* also be used.
+
+# Controls the placing and visibility of the secondary column
+# Values: left | right | none
+# - left: The secondary column appears on the left side of the main column
+# - right: The secondary column appears on the right side of the main column
+# - none: There is no secondary column (note that this also inhibits the tertiary column)
+# Here the default value is defined, pages may override this in their front matter.
+# The secondary column must reside in the "_includes" directory and is called "secondary-column.html"
+# Front matter can specify a different file for the secondary column ("secondary-column-content").
+#
+secondary-column: left
+
+# Controls visibility of the tertiary column
+# Values: present | none
+# - present: The tertiary column is visible.
+# - none: There is no tertiary column.
+# The tertiary column is always on the opposite side of the main column from the secondary column.
+# Here the default value is defined, pages may override this in their front matter.
+# The tertiary column must reside in the "_includes" directory and is called "tertiary-column.html"
+# Front matter can specify a different file for the tertiary column ("tertiary-column-content").
+#
+tertiary-column: present
+
+# A subtitle can be displayed in de banner
+#
+subtitle: "Uses Swift instead of PHP"
+
+# Skip some of the build process for faster recompilation during content creation.
+# Values: yes | no
+# - yes: If the jekyll.environment variable is *not* set to 'production', then various aspects (menu, categories) are skipped during jekyll compilation. This speeds up the content development cycle quite a lot.
+# - no: Always generate the site completely.
+#
+# Currently applies to the dropdown menu, the vertical-menu, the categories (widget), the older-posts widget and the recent-post widget.
+# Since the menu structure is not available for site navigation, use the url to view the content under creation. Or first view the new content, then enable fast content build and use refresh in the browser.
+#
+fast-content-build: no
+
+# Use site favicons as generated by the website: https://realfavicongenerator.net.
+# Values: yes | no
+# - yes: Upload the image to be used as favicon to that site, create a favicon files folder called 'icons', download the generated file/folder and replace the contents of the site's icons directory with the files from realfavicongenerator.
+# - no: The folder 'icons' can be removed.
+#
+realfavicongenerator: yes
+
+# For the number of posts visible on the home page.
+# Value: > 0
+#
+number-of-posts-on-home-page: 5
+
+# For the number of posts titles shown in the 'recent' widget
+# Value: > 0
+#
+number-of-recent-posts-in-widget: 10
+
+# Enables or disables the cookies warning.
+# Values: yes | no
+#
+enable-cookies-policy: no
+
+# Controls the position of the banner and menubar.
+# Values: top | main | top-fixed
+# - top: The navigation banner will be placed above all the columns
+# - main: The navigation banner will be placed inside the main column at the top.
+# - top-fixed: The navigation banner will be placed above all the columns and remain in place when scrolling down.
+# This is the default value, pages may override this in their YAML frontmatter. But beware the anchor offset!
+#
+# $anchor-top-fixed-offset-xxxxx should be zero for 'top' and 'main' and should be set to the banner-area height
+# for 'top-fixed'. (See classic-jekyll-theme.scss)
+#
+# Hint 1: When the 'top-fixed' is used a background color should be specified for the banner and menu.
+# Hint 2: It is recommended not to use the youtube-player widget when using 'top-fixed'. Because the youtube-player widget will scroll in front of the banner.
+#
+banner-position: top
+
+# Switches between drop-down menu's en the vertical-menu for the subMenuTitles. It does not affect the top menu items with the exception of the 'Categories' item.
+# Only works for medium and widest layouts, the narrow layout always used the menubar instead of the vertical-menu. (Which is displayed vertically anyhow)
+# Values: yes | no
+# - yes: The drop down menu is used, the vertical menu is not shown. The Categories menu item is generated when the generate-categories-menu is set to 'yes'.
+# - no: The vertical menu is used, the drop down menu is not shown. The Categories menu is not created, even when the generate-categories-menu is set to 'yes'.
+#
+# Note 1: The drop down menu does not display sub-sub menu items, the vertical menu does.
+# Note 2: When the drop-down menus are not used, any items in the menubar without a linked page will become useless.
+# Note 3: Setting to 'no' will result in slower compilation. If possible, setting this to 'yes' during content development will help speed up the workflow.
+#
+drop-down-menu: yes 
+
+# Controls the generation of the categories menu entry in the menu bar if the drop-down-menu option is set to 'yes'. Has no impact on the categories widget.
+# Values: yes | no
+# - yes: The categories menu entry is generated if -and only if- the drop-down-menu option is set to 'yes'.
+# - no : The categories menu entry is not generated.
+#
+generate-categories-menu: no
+
+# Create a separate file containing the banner and menubar.
+# Values: yes | no
+# - yes: An external file will be used to store the menubar.
+# - no: Generated the menubar inline.
+#
+# This option uses javascript. Choosing 'yes' will download the jQuery javascript library from google.
+#
+# Using a separate banner-area file speeds up jekyll compilation a lot. However it also means that the browser has to make two additional fetches: the navbanner file and the jQuery library (the latter from google). This is mitigated by the fact that both files can be cached by the browser.
+# If another jQuery library has to be used, edit the _includes/head.html file accordingly.
+#
+# Note 1: If this option is set to 'yes', then make sure the file 'banner-area.md' is present (can be found in the theme folder) in the same project folder as the index.md file.
+#
+# Note 2: When a separate navbanner file is used the menubar will not be able to highlight the active page.
+#
+# Hint: Keep this option set to 'yes' during content creation or site development (when jekyll auto regeneration is used). Then switch it back to 'no' for the version that is published.
+#
+use-separate-banner-menubar-file: no
+
+# Exclude pages from the menu structure. Note that this uses negative logic for backwards compatibility.
+# Values: yes | no
+# - yes: Pages will not be included in any menu structure
+# - no: Pages will be included in all menu structures
+#
+exclude-pages-from-menus: no
+
+# Included posts in any menu structure.
+# Values: yes | no
+# - yes: Posts will be scanned for inclusion in all menu structures.
+# - no: Posts will be excluded from the menu structures.
+#
+include-posts-in-menus: yes
+
+
+# End of file

data/_data/text-for.yml

@@ -0,0 +1,53 @@
+# Language customization for default theme elements
+
+# Menu item
+tHome: Home
+
+# Title on home page
+tPosts: Posts
+
+# Menu item
+tCategories: Categories
+
+# Title on categories page
+tCategory: Category
+
+# When no categories are present
+tNoCategories: None
+
+# Message on category page if no posts have been found
+tNoBlogpostFound: No blogposts found for this category
+
+# Continuation text for abbreviated posts on a category page
+tMore: more
+
+# Tag label on category page
+tTags: Tags
+
+# Title on recent posts widget
+tRecent: Recent
+
+# Part title of social media widget
+tSocialMediaResources: Social Media & Resources
+
+# Title of subscription widget
+tSubscribe: Subscribe
+
+# Cookie warning message
+tUsesCookies: This site uses cookies
+
+# Text for OK button
+tCookieOk: OK
+
+# More cookie info text
+tMoreInfo: More info
+
+# Title for Older Posts widget output
+tOlderPosts: Older Posts
+
+# Month names for Older Posts widget output
+# Note: Must start with 'None' because of index starting at 0
+tMonths: [None, January, February, March, April, May, June, July, August, September, October, November, December]
+
+# Text to be displayed for articles that will be published in the future.
+tFutureRelease: This article is scheduled for release in the near future.

data/_includes/account-menus.html

@@ -0,0 +1,82 @@
+.if($account.is-domain-admin, equal, true)
+<div class="item-separator"><p><!-- empty but necessary --></p></div>
+<div class="item">
+	<div class="title">
+		<label class="symbol"><p></p></label>
+		<div class="text"><p class="paddingAsLink">Admin</p></div>
+	</div>
+	<div class="dropdown">
+		<div class="subitem-separator"><p></p></div>
+		<div class="subitem">
+			<div class="title">
+				<div class="symbol"></div>
+				<div class="text">
+					<a href="{%- link pages/account/comment-review.sf.md -%}"><p>Review Comments Needing Approval</p></a>
+				</div>
+			</div>
+		</div>
+	</div>
+</div>
+.else()
+	.if($account.is-moderator, equal, true)
+<div class="item-separator"><p><!-- empty but necessary --></p></div>
+<div class="item">
+	<div class="title">
+		<label class="symbol"><p></p></label>
+		<div class="text"><p class="paddingAsLink">Moderator</p></div>
+	</div>
+	<div class="dropdown">
+		<div class="subitem-separator"><p></p></div>
+		<div class="subitem">
+			<div class="title">
+				<div class="symbol"></div>
+				<div class="text">
+					<a href="{%- link pages/account/comment-review.sf.md -%}"><p>Review Comments Needing Approval</p></a>
+				</div>
+			</div>
+		</div>
+	</div>
+</div>
+	.end()
+.end()
+<div class="item-separator"><p><!-- empty but necessary --></p></div>
+<div class="item">
+	<div class="title">
+		<label class="symbol"><p></p></label>
+		<div class="text"><p class="paddingAsLink">Account</p></div>
+	</div>
+	<div class="dropdown">
+		<div class="subitem-separator"><p></p></div>
+		.if($account, equal, nil)
+		<div class="subitem">
+			<div class="title">
+				<div class="symbol"></div>
+				<div class="text">
+					<a href="{%- link pages/account/login.sf.md -%}"><p>Login</p></a>
+				</div>
+			</div>
+		</div>
+		<div class="subitem-separator"><p></p></div>
+		<div class="subitem">
+			<div class="title">
+				<div class="symbol"></div>
+				<div class="text">
+					<a href="{%- link pages/account/register.sf.md -%}"><p>Register</p></a>
+				</div>
+			</div>
+		</div>
+		.else()
+		<div class="subitem">
+			<div class="title">
+				<div class="symbol"></div>
+				<div class="text">
+					<a href="/command/logout"><p>Logout .show($account.name!)</p></a>
+				</div>
+			</div>
+		</div>
+		.end()
+	</div>
+
+</div>
+
+

data/_includes/banner-area.html

@@ -0,0 +1,57 @@
+
+<!-- include banner-area.html -->
+{%- comment -%}<!--
+
+Layout of the banner area.
+
+The banner area is complex in the sense that some elements are out of the DOM permanently and some elements are out of the DOM depending on the settings in the site.data.setup file.
+
+The height of the 'banner' class must be specified explicitly in the theme.scss file.
+
+The icon, title and label are placed on top of the banner using relative/absolute positioning.
+
+The conditional part for 'top-fixed' is present to make sure that the content of the column-panel is properly offset from the top of the screen such that no partion of it is positioned behind the banner-area. It has the same classes and structure as the banner-area so that it auto-adjusts for menubar switching (using the banner-menu-symbol).
+
+If changes are made to this file that increase the height of the banner-area that is placed outside the DOM, the HTML code can compensate for the height increase by specifying a height for the add-to-banner-area-height class.
+
+-->{%- endcomment -%}
+
+{%- if site.data.setup.banner-position == 'top-fixed' -%}
+	{%- assign banner-classes = 'banner-area banner-area-outside-dom' -%}
+{%- else -%}
+	{% assign banner-classes = 'banner-area banner-area-in-dom' -%}
+{%- endif %}
+<input type="checkbox" id="banner-menu-symbol">
+<div class="{{ banner-classes }}">
+	<div class="banner"></div>
+	{%- comment -%}<!-- The following elements are permanently outside the DOM -->{%- endcomment %}
+	<div class="icon-container">
+		{% include banner-icon.html %}
+	</div>
+	<div class="title-area-container">
+		{% include banner-title-area.html %}
+	</div>
+	<div class="label-container"><label for="banner-menu-symbol"><p><!-- empty but necessary! --></p></label></div>
+	{%- comment -%}<!-- This is part of the DOM again (unless the banner area is outside the DOM) -->{%- endcomment %}
+	<div class="menubar-top-separator"></div>
+	{% include menubar.html %}
+	<div class="menubar-bottom-separator"></div>
+</div>
+{%- if site.data.setup.banner-position == 'top-fixed' %}
+<div class="banner-area invisible">
+	<div class="banner"></div>
+	<div class="menubar-top-separator"></div>
+	<div class="menubar">
+		{% include menubar-icon.html %}
+		<div class="item">
+			<div class="title">
+				<div class=symbol><p></p></div>
+				<div class="text"><a><p>Home</p></a></div>
+			</div>
+		</div>
+	</div>
+	<div class="menubar-bottom-separator"></div>
+	<div class="add-to-banner-area-height"></div>
+</div>
+{% endif -%}
+<!-- end of include banner-area.html -->