{"id":21861739,"url":"https://github.com/alertbox/bookworm","last_synced_at":"2025-04-14T19:40:31.659Z","repository":{"id":46623083,"uuid":"280360259","full_name":"alertbox/bookworm","owner":"alertbox","description":"A delightfully lightweight, mobile-first, and fluidly responsive Jekyll theme for books and creative writing that emphasizes content rather than aesthetic fluff.","archived":false,"fork":false,"pushed_at":"2021-10-03T12:50:56.000Z","size":2791,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T08:02:32.950Z","etag":null,"topics":["bookworm-theme","devcontainers","jekyll","jekyll-theme","vscode"],"latest_commit_sha":null,"homepage":"https://alertbox.github.io/bookworm/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alertbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-17T07:42:51.000Z","updated_at":"2025-03-12T16:13:57.000Z","dependencies_parsed_at":"2022-09-11T14:20:38.177Z","dependency_job_id":null,"html_url":"https://github.com/alertbox/bookworm","commit_stats":null,"previous_names":[],"tags_count":19,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Fbookworm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Fbookworm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Fbookworm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Fbookworm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alertbox","download_url":"https://codeload.github.com/alertbox/bookworm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248947976,"owners_count":21187782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bookworm-theme","devcontainers","jekyll","jekyll-theme","vscode"],"created_at":"2024-11-28T03:12:30.731Z","updated_at":"2025-04-14T19:40:31.641Z","avatar_url":"https://github.com/alertbox.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bookworm\n![Build](https://github.com/alertbox/bookworm/workflows/Build/badge.svg)\n![Publish](https://github.com/alertbox/bookworm/workflows/Publish/badge.svg)\n\n[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.\n\nOriginally, 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).\n\n![Screenshot](screenshot.png)\n\n\u003e The Bookworm in action.\n\n## Content\n- [Features](#features)\n- [Requirements](#requirements)\n- [Using This Theme](#using-this-theme)\n- [Feedback](#feedback)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n- Best for GitHub Pages theme: `template` repo or `remote_theme`\n- No need to install and setup Ruby and Jekyll locally\n- Build and run locally\n- Designed for mobile first and fluid responsive for all devices\n- Customizable look and feel\n- Built-in support for: PWA, Deep anchor links, and Telemetry\n- Duplicated from the [Pixyll](https://pixyll.com) theme\n- Powered by Jekyll and VS Code Remote - Containers\n\n## Requirements\nSee [@kosalanuwan/devcontainers](https://github.com/kosalanuwan/devcontainers) repository to get started at the most basic level, and:\n\n- 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.\n\n## Use This Theme\nIf 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.\n\nNext, 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.\n\n### Enable `remote_theme`\nIt is easier to use Bookworm as your Jekyll theme. You will want to do followings:\n\n- Enable remote theme in `_config.yml`.\n  ```yml\n  # _config.yml\n  remote_theme: alertbox/bookworm\n  plugins:\n    - jekyll-remote-theme\n  ```\n- Add jekyll plugins in `Gemfile` to support remote theme\n  ```ruby\n  # Gemfile\n  group :jekyll_plugins do\n  gem 'github-pages'\n  gem 'jekyll-remote-theme'\n  # ... any other plugins as you wish\n  end\n  ```\n- Clean up unwanted files and folders\n  ```bash\n  rm -rf _includes _layouts _sass assets\n  ```\n\nThat's it. You now have a copy of the Bookworm repo that uses Bookworm Theme, and is ready to preview locally.\n\n### Preview Locally\nFirst, you want to ensure source code is Reopened in Container and the tasks are executable. Then build and run the template locally.\n\nWith VS Code:\n- Run task: `build` to clean build and generate the static site\n- Run task: `live-serve` to preview locally\n\nThen, you launch your favorite browser and visit [localhost:8004/bookworm/](http://localhost:8004/bookworm/).\n\n## Contributing\nThere are many ways in which you can participate in the project. Please see the document [How to Contribute](CONTRIBUTING.md).\n\n## Feedback\nWe would love for you to give all sorts of feedback. Here are the ways you can provide feedback:\n\n- [Request a new feature](https://github.com/alertbox/bookworm/issues/new?assignees=\u0026labels=\u0026template=feature_request.md\u0026title=)\n- Upvote [popular feature requests](https://github.com/alertbox/bookworm/issues)\n- [Report an issue](https://github.com/alertbox/bookworm/issues/new?assignees=\u0026labels=\u0026template=bug_report.md\u0026title=)\n- Follow [@alertboxinc](https://twitter.com/alertboxinc) and let me know what you think!\n\n## License\nCopyright :copyright: Alertbox Inc. All rights reserved.\n\nThe source code is license under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertbox%2Fbookworm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falertbox%2Fbookworm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertbox%2Fbookworm/lists"}