diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 646b92c3d..000000000 --- a/Gemfile +++ /dev/null @@ -1,4 +0,0 @@ -source "https://rubygems.org" - -gem "github-pages", group: :jekyll_plugins -gem "jekyll-include-cache", group: :jekyll_plugins diff --git a/_config.yml b/_config.yml index 98db0ebdf..67f72cd42 100644 --- a/_config.yml +++ b/_config.yml @@ -1,204 +1,15 @@ -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:malcolm@inl.gov" - - 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:malcolm@inl.gov" - - 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 +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/minimal@v0.2.0 +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 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) -# - /tags/my-awesome-tag/index.html ~> path: /tags/ -# - /categories/my-awesome-category/index.html ~> path: /categories/ -# - /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 diff --git a/_includes/head-custom.hml b/_includes/head-custom.hml new file mode 100644 index 000000000..3214c6397 --- /dev/null +++ b/_includes/head-custom.hml @@ -0,0 +1,6 @@ + + + + + + diff --git a/_layouts/default.html b/_layouts/default.html index 0c9d34275..7d8e77458 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -16,13 +16,15 @@
{% if site.logo %} - Logo + Logo {% else %}

{{ site.title | default: site.github.repository_name }}

{% endif %}

{{ site.description | default: site.github.project_tagline }}

+

Home

+

Documentation

{% if site.github.is_project_page %}