Welcome to the Starter Log Jekyll theme!
This minimalist theme for technical writing and ranting was handcrafted by the Practitioners at Gadgetry.io so that we could share our inner daemons :) We've open sourced it so that others may also use if for personal and professional projects.
The theme is available as open source under the terms of the MPL-2.0 License.
- Ruby Version = 2.3.0p0
- Bundler Version 1.12.5
- Jekyll Version = 3.2.1
To demo and experiment with this code, simply install the dependencies and clone the project to your local workspace. Run
bundle install to pull in any gem dependencies and then run
jekyll serve – this directory is setup just like a Jekyll site!
To use this theme in your existing Jekyll project... Add this line to your Jekyll site's Gemfile:
And add this line to your Jekyll site:
And then execute:
Or install it yourself as:
$ gem install starterlog-theme
The Starter Log Theme is great for personal and professional projects. It provides a custom boostrap theme and color scheme, layouts, includes, static pages, assets, and lunr search functionality that you can use to build out a fully functional jekyll project that compliments your technical writing...
Core components such as bootstrap, font-awesome, jquery, and lunr.js were used to develop the theme, and make it very simple to extend and build upon.
/ _includes ## HEAD, HEADER AND FOOTER (e.g. Navbar) footer.html head.html header.html _layouts ## LAYOUTS DIRECTORY default.html page.html post.html _pages ## PAGES DIRECTORY FOR STATIC PAGES (html) assets ## FONTS, IMAGES, SCRIPTS, STYLES fonts images modules reveal.js scripts styles
Reveal.js is now included in the theme and allows you to create HTML presentations directly in your Jekyll site as a simple Post using HTML and Markdown syntax.
In the Front Matter of any Jekyll Post on your site, simply use the slide layout and specify the reveal.js theme you wish to use.
--- layout: slide title: Sample Presentation description: A presentation slide for how to use reveal.js in Jekyll theme: white transition: slide date: 2017-01-03 00:00:00 -0600 categories: presentation ---
Reveal.js HTML Presentations
Custom Bootstrap Theme
Static Page Templates
Bug reports and pull requests are welcome on GitHub at https://github.com/gadgetry-io/theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
To set up your environment to develop this theme, run
You theme is setup just like a normal Jekyll site!
To test your theme, run
bundle exec jekyll serve and open your browser at
http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to this theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.