Bookworm

Bookworm is pretty minimal, but leverages large type and drastic contrast to make a statement, on all devices. It is a delightfully lightweight, mobile first, and fluidly responsive Jekyll theme for books and creative writing that emphasizes content rather than aesthetic fluff.

Originally, it was a duplicate of Pixyll V2 and V3 crafted with :heart:. This repo is also a GitHub Page Template. Check out the GitHub's Template Repositories.

The Bookworm in action.

Content

• Features
• Requirements
• Using This Theme
• Feedback
• Contributing
• License

Features

• Best for GitHub Pages theme: template repo or remote_theme
• No need to install and setup Ruby and Jekyll locally
• Build and run locally
• Designed for mobile first and fluid responsive for all devices
• Customizable look and feel
• Built-in support for: PWA, Deep anchor links, and Telemetry
• Duplicated from the Pixyll theme
• Powered by Jekyll and VS Code Remote - Containers

Requirements

See @kosalanuwan/devcontainers repository to get started at the most basic level, and:

• A Markdown editor, the lightweight and easy-to-use syntax for all forms of writing on GitHub platform.

Use This Theme

If you're completely new to Jekyll, Smashing Magazine tutorial on Jekyll is a good source to start with.

Next, you want to create a copy of this template. The repository is marked as a Template so you will only have to Use This Template and follow the instructions. Read more about this in the GitHub's Template Repositories document.

Enable remote_theme

It is easier to use Bookworm as your Jekyll theme. You will want to do followings:

• Enable remote theme in _config.yml.

  # _config.yml
  remote_theme: alertbox/bookworm
  plugins:
    - jekyll-remote-theme
  

• Add jekyll plugins in Gemfile to support remote theme

  # Gemfile
  group :jekyll_plugins do
  gem 'github-pages'
  gem 'jekyll-remote-theme'
  # ... any other plugins as you wish
  end
  

• Clean up unwanted files and folders

  rm -rf _includes _layouts _sass assets
  

That's it. You now have a copy of the Bookworm repo that uses Bookworm Theme, and is ready to preview locally.

Preview Locally

First, you want to ensure source code is Reopened in Container and the tasks are executable. Then build and run the template locally.

With VS Code:

• Run task: build to clean build and generate the static site
• Run task: live-serve to preview locally

Then, you launch your favorite browser and visit localhost:8004/bookworm/.

Contributing

There are many ways in which you can participate in the project. Please see the document How to Contribute.

Feedback

We would love for you to give all sorts of feedback. Here are the ways you can provide feedback:

• Request a new feature
• Upvote popular feature requests
• Report an issue
• Follow @alertboxinc and let me know what you think!

License

Copyright :copyright: Alertbox Inc. All rights reserved.

The source code is license under the MIT License.