Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alertbox/bookworm
A delightfully lightweight, mobile-first, and fluidly responsive Jekyll theme for books and creative writing that emphasizes content rather than aesthetic fluff.
https://github.com/alertbox/bookworm
bookworm-theme devcontainers jekyll jekyll-theme vscode
Last synced: 2 months ago
JSON representation
A delightfully lightweight, mobile-first, and fluidly responsive Jekyll theme for books and creative writing that emphasizes content rather than aesthetic fluff.
- Host: GitHub
- URL: https://github.com/alertbox/bookworm
- Owner: alertbox
- License: mit
- Created: 2020-07-17T07:42:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-03T12:50:56.000Z (over 3 years ago)
- Last Synced: 2024-04-28T01:44:32.926Z (9 months ago)
- Topics: bookworm-theme, devcontainers, jekyll, jekyll-theme, vscode
- Language: SCSS
- Homepage: https://alertbox.github.io/bookworm/
- Size: 2.66 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Bookworm
[Bookworm](https://alertbox.github.io/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](https://github.com/johno/pixyll) crafted with :heart:. This repo is also a GitHub Page Template. Check out [the GitHub's Template Repositories](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
> The Bookworm in action.
## Content
- [Features](#features)
- [Requirements](#requirements)
- [Using This Theme](#using-this-theme)
- [Feedback](#feedback)
- [Contributing](#contributing)
- [License](#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](https://pixyll.com) theme
- Powered by Jekyll and VS Code Remote - Containers
## Requirements
See [@kosalanuwan/devcontainers](https://github.com/kosalanuwan/devcontainers) repository to get started at the most basic level, and:
- A [Markdown](https://guides.github.com/features/mastering-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](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/) 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](https://github.com/alertbox/bookworm/generate/) and follow the instructions. Read more about this in [the GitHub's Template Repositories](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) 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`.
```yml
# _config.yml
remote_theme: alertbox/bookworm
plugins:
- jekyll-remote-theme
```
- Add jekyll plugins in `Gemfile` to support remote theme
```ruby
# 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
```bash
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/](http://localhost:8004/bookworm/).
## Contributing
There are many ways in which you can participate in the project. Please see the document [How to Contribute](CONTRIBUTING.md).
## Feedback
We would love for you to give all sorts of feedback. Here are the ways you can provide feedback:
- [Request a new feature](https://github.com/alertbox/bookworm/issues/new?assignees=&labels=&template=feature_request.md&title=)
- Upvote [popular feature requests](https://github.com/alertbox/bookworm/issues)
- [Report an issue](https://github.com/alertbox/bookworm/issues/new?assignees=&labels=&template=bug_report.md&title=)
- Follow [@alertboxinc](https://twitter.com/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](LICENSE).