Skip to content
This repository has been archived by the owner on Aug 14, 2021. It is now read-only.

MichaelHabib/mh-jekyll-theme

Repository files navigation

MH Jekyll Theme

This is a Jekyll theme used for www.notebook.michaelhabib.name .

Goals

Create a simple Jekyll theme that supports BootStrap CSS Framework & Asciidoc Markup Language, in addition to useful build tools & community Asciidoc extensions.

Usage

  • Insure gem bundler installed with gem install bundler .

  • Install jekyll and other gems using bundler install .

  • Initiate jekyll site by running jeykyll new . then start the build process with `jekyll build ` .

  • Check the use_docker file for docker command examples .

To upload the build results to an sftp server : - Encrypt then add sftp authentication details to .travis.yml . Instructions can be found on https://docs.travis-ci.com/user/encryption-keys/ https://docs.travis-ci.com/user/deployment/custom/ - Remember to add the --pro option to the travis command when using travis-ci.com instead of the .org counterpart .

Commands & Code Samples

jekyll serve --watch --port 3897 --host 0.0.0.0 --drafts --trace

Build Process

Dependencies & Technologies Used

ToDo

  • ✓ Index of all page

  • ✓ Index of all posts

  • ✓ Index of all categories

  • ✓ Archive pages using jekyll-archives

  • ❏ Wiki Collection

    • ✓ Create wiki collection

    • ✓ Custom wiki permalink.

    • ❏ Allow wiki page namespaces, categories & tags

  • ❏ Projects Collection **

  • Sitemap

    • Auto generate siemap

    • Add wiki collection to sitemap

  • Home Page Template Changes

    • ❏ Custom Home Page template

    • [ ]

  • ❏ Enable URL specific template from _config.yml

    • ❏ Remove page specific template config from content files.

  • Post Template Changes

    • ✓ Clickable categories

  • Posts Template Changes

    • ✓ Clickable categories

  • Category Template Changes

    • [ ]

  • Categories Template Changes

    • ❏ List primary categories by showing the first category from each post.

    • [ ]

  • Archive Template Changes

    • [ ]

  • ❏ SMM & Analytics Integrations

    • ❏ GTM

    • ❏ FB Pixel

  • Primary Navigation Setup

    • ❏ Nav items : Home | About | Wiki | Blog | Projects | Contact

Changelog

V0.1.0

V0.1.1

V0.2.0

  • Upgraded to Jekyll 4.2.0

  • Updated dependencies.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published