Skip to content

Commit

Permalink
experimenting with github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Sep 22, 2022
1 parent b9925dc commit f43a4aa
Show file tree
Hide file tree
Showing 4 changed files with 206 additions and 21 deletions.
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins
gem "jekyll-include-cache", group: :jekyll_plugins
213 changes: 201 additions & 12 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,204 @@
title: Malcolm
description: Malcolm is a powerful, easily deployable network traffic analysis tool suite.
logo: docs/images/logo/Malcolm_outline_banner_dark.png
remote_theme: pages-themes/[email protected]
external_download_url: https://malcolm.fyi/download/
docs_uri: docs/
github:
owner_name: Seth Grover
plugins:
- jekyll-remote-theme
- jekyll-relative-links
show_downloads: true
minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"

# Site Settings
locale : "en-US"
title : "Malcolm"
title_separator : "-"
subtitle : # site tagline that appears below site title in masthead
name : "Seth Grover"
description : "A powerful, easily deployable network traffic analysis tool suite"
url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl : # the subpath of your site, e.g. "/blog"
repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png"
logo : "/docs/images/logo/Malcolm_outline_banner_dark.png"
masthead_title : # overrides the website title displayed in the masthead, use " " for no title
breadcrumbs : true
words_per_minute : 200
atom_feed:
hide : true
search : false
search_full_content : false
search_provider : lunr
lunr:
search_within_pages : false

# Site Author
author:
name : "Seth Grover"
avatar : # path of avatar image, e.g. "/assets/images/bio-photo.jpg"
bio : #
location : "Idaho Falls, Idaho, USA"
email :
links:
- label: "Email"
icon: "fas fa-fw fa-envelope-square"
url: "mailto:[email protected]"
- label: "Website"
icon: "fas fa-fw fa-link"
url: "https://malcolm.fyi/"
- label: "YouTube"
icon: "fas fa-fw fa-youtube"
url: "https://www.youtube.com/c/MalcolmNetworkTrafficAnalysisToolSuite"
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: "https://github.com/mmguero"

# Site Footer
footer:
links:
- label: "Email"
icon: "fas fa-fw fa-envelope-square"
url: "mailto:[email protected]"
- label: "Website"
icon: "fas fa-fw fa-link"
url: "https://malcolm.fyi/"
- label: "YouTube"
icon: "fas fa-fw fa-youtube"
url: "https://www.youtube.com/c/MalcolmNetworkTrafficAnalysisToolSuite"
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: "https://github.com/mmguero"

# Reading Files
include:
- README
- /docs
exclude:
- "*.sublime-project"
- "*.sublime-workspace"
- vendor
- .asset-cache
- .bundle
- .jekyll-assets-cache
- .sass-cache
- assets/js/plugins
- assets/js/_main.js
- assets/js/vendor
- Capfile
- CHANGELOG
- config
- Gemfile
- Gruntfile.js
- gulpfile.js
- LICENSE
- log
- node_modules
- package.json
- package-lock.json
- Rakefile
- tmp
keep_files:
- .git
- .svn
encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"


# Conversion
markdown: kramdown
highlighter: rouge
lsi: false
excerpt_separator: "\n\n"
incremental: false


# Markdown Processing
kramdown:
input: GFM
hard_wrap: false
auto_ids: true
footnote_nr: 1
entity_output: as_char
toc_levels: 1..6
smart_quotes: lsquo,rsquo,ldquo,rdquo
enable_coderay: false


# Sass/SCSS
sass:
sass_dir: _sass
style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style


# Outputting
permalink: /:categories/:title/
paginate: 5 # amount of posts to show
paginate_path: /page:num/
timezone: "America/Boise"

# Relative links
relative_links:
enabled: true
collections: true

# Plugins (previously gems:)
plugins:
- jekyll-feed
- jekyll-gist
- jekyll-include-cache
- jekyll-include-cache
- jekyll-paginate
- jekyll-relative-links
- jekyll-remote-theme
- jekyll-sitemap

# mimic GitHub Pages with --safe
whitelist:
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-feed
- jekyll-include-cache


# Archives
# Type
# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
# - Jekyll Archives plugin archive pages ~> type: jekyll-archives
# Path (examples)
# - Archive page should exist at path when using Liquid method or you can
# expect broken links (especially with breadcrumbs enabled)
# - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
# - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/
# - <base_path>/my-awesome-category/index.html ~> path: /
category_archive:
type: liquid
path: /categories/
tag_archive:
type: liquid
path: /tags/
# https://github.com/jekyll/jekyll-archives
# jekyll-archives:
# enabled:
# - categories
# - tags
# layouts:
# category: archive-taxonomy
# tag: archive-taxonomy
# permalinks:
# category: /categories/:name/
# tag: /tags/:name/


# HTML Compression
# - https://jch.penibelst.de/
compress_html:
clippings: all
ignore:
envs: development


# Defaults
defaults:
# _posts
- scope:
path: ""
type: posts
values:
layout: single
author_profile: true
read_time: true
comments: # true
share: true
related: true
6 changes: 0 additions & 6 deletions _includes/head-custom.hml

This file was deleted.

4 changes: 1 addition & 3 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,13 @@
<div class="wrapper">
<header>
{% if site.logo %}
<img src="{{site.logo | relative_url}}" alt="Logo" />
<a href="{{ "/" | absolute_url }}"><img src="{{site.logo | relative_url}}" alt="Logo" /></a>
{% else %}
<h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
{% endif %}

<p>{{ site.description | default: site.github.project_tagline }}</p>

<p class="view"><a href="{{ "/" | absolute_url }}">Home</a></p>

<p class="view"><a href="{{ site.docs_uri | default: / | relative_url }}">Documentation</a></p>

{% if site.github.is_project_page %}
Expand Down

0 comments on commit f43a4aa

Please sign in to comment.