Domain

Jekyll Knowledge Base / Blog Theme that provides wiki style linking, full text search and automatically generated post organization pages.

• Option 1: Use the Domain Github Pages Initializer
• Option 2: Setup as a gem-based theme
• Option 3: Setup as a remote theme
• Option 4: Forking/directly copying all of the theme files into your project.

With Gem-based themes, directories such as the assets, _layouts, _includes, and _sass are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.

This allows for easier installation and updating as you don't have to manage any of the theme files. To install:

1. Add the following to your Gemfile:

   gem "domain-jekyll"

2. Fetch and update bundled gems by running the following Bundler command:

   bundle

3. Set the theme in your project's Jekyll _config.yml file:

   theme: domain-jekyll

To update the theme run bundle update.

Remote themes are similar to Gem-based themes, but do not require Gemfile changes or whitelisting making them ideal for sites hosted with GitHub Pages.

To install:

1. Create/replace the contents of your Gemfile with the following:

   source "https://rubygems.org"
   
   gem "github-pages", group: :jekyll_plugins

2. Fetch and update bundled gems by running the following Bundler command:

   bundle

3. Add remote_theme: "Lumunix/Domain" to your _config.yml file. Remove any other theme: or remote_theme: entry.

For detailed instructions on how to configure, customize, read the theme's documentation.

Included in the repository is a docker-compose file that creates a container from the the official Jekyll Docker Image. This will allow you to setup a development environment without having to install Ruby and Jekyll manually and allow you to quickly test and preview changes.

1. Fork this repo. Clone it to your machine.

2. Install Docker/Compose. You must have Docker and Compose installed.

3. In the directory you downloaded the project, open terminal and run the following command docker compose up.

4. You should now be able to go to your web browser and view the site Here