https://github.com/brightprogrammer/purelog
https://github.com/brightprogrammer/purelog
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brightprogrammer/purelog
- Owner: brightprogrammer
- License: mit
- Created: 2021-08-13T16:51:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-13T16:51:34.000Z (over 4 years ago)
- Last Synced: 2025-01-10T15:35:57.289Z (about 1 year ago)
- Language: HTML
- Size: 306 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Purelog Theme for Jekyll
A responsive, well-designed template to help you get started on your next blog or website.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## About The Project
**Purelog** is a responsive, sidebar theme for the popular JAMstack generator Jekyll that only uses the minimal [**Pure.css** framework](https://github.com/pure-css/pure) (hence the name!), while still following the best practices possible for accessibility and search-engine optimization.
I created this after finishing [Watery](https://github.com/brennanbrown/watery) (which this theme is built off of), as a way to add more functionality and design while still remaining as lightweight as possible.
This project is aimed towards those looking for an interesting theme for Jekyll that has features that aren't found commonly elsewhere, specifically having separate sections dedicated towards: blogging, note-taking, and daily journal entries.
### Features
Here are a few interesting features of this Jekyll theme:
- A fully customizable and empty `_BLANK_config.yml` to make getting up-and-running easy.
- A speedy, on-site search function using [Simply Jekyll Search](https://github.com/christian-fei/Simple-Jekyll-Search).
- Custom collections for different types of material (note-taking, journal writing, etc.)
- An auto-generating archive page that displays all entries from _all_ collections.
- Auto-generating tags and categories pages.
- Having a `_pages` collection for easier organization.
- An author bio at the end of each post. (Located in `_inclues/author.html`)
- Full Rouge support for syntax highlighting. (Currently using `base16.solarized.light`)
- Auto-generated RSS feed, sitemap, accessibility features, and search-engine optimization.
## Installation
### Prerequisites
Jekyll requires the following:
- Ruby version **2.5.0** or higher
- RubyGems
- GCC and Make
See [Requirements](https://jekyllrb.com/docs/installation/#requirements) for guides and details.
### Instructions
1. Install all [prerequisites](https://jekyllrb.com/docs/installation/).
2. Install the jekyll and bundler [gems](https://jekyllrb.com/docs/ruby-101/#gems).
```
gem install jekyll bundler
```
3. Clone this repository.
```
git clone https://github.com/brennanbrown/purelog.git
```
4. Change into your new directory.
```
cd purelog
```
5. Install gems from the `Gemfile`.
```
bundle install
```
6. Build the site and make it available on a local server.
```
bundle exec jekyll serve
```
7. Browse to [http://localhost:4000](http://localhost:4000)
If you encounter any errors during this process, check that you have installed all the prerequisites in [Requirements](https://jekyllrb.com/docs/installation/#requirements).
If you still have issues, see [Troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems).
## Getting Started
Once you have Jekyll up-and-running, there are only a few steps needed to make this theme your own:
1. Fill out the `_BLANK_config.yml` configuration file and replace the current `_config.yml`
2. Remove the `example_posts` folder in `_posts`, `_notes`, `_journals` and start writing your own!
3. Modify or remove the pages in `_pages` to however you see fit.
4. _(Optional)_ Modify or remove this `README.md` with information about your own project or blog.
5. _(Optional)_ Modify the CSS files in the `assets` folder to customize the site.
## Roadmap
There are several features that I'm still planning to create and integrate, including:
- Create a [Theme Gem](https://jekyllrb.com/docs/themes/#publishing-your-theme)
- Add easy and automatic buttons to ["Deploy to Netlify"](https://docs.netlify.com/site-deploys/create-deploys/#deploy-to-netlify-button), Heroku, etc.
- Add Travis continious integration checks
- Add additional documentation for creating custom collections and auto generated pages
- Add more example posts and articles
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. You can use this project however you see fit without needing to give attribution.
See `LICENSE` for more information.
## Resources
While creating this theme, I came across a lot of helpful and hard-to-find resources. If you'd like to dive deeper into Jekyll, check them out:
- Jumping Into Jekyll:
- Jekyll Cheatsheet:
- Course on Jekyll:
- Jekyll for Designers:
- Dynamic Copyright on Jekyll:
- Creating breadcrumbs in Jekyll:
- Display all items from ALL collections:
### Other Resources
- For markdown previews:
- Case Study on webfont performance:
- An extensive `.gitignore`:
## Credit
[**Pure.css**](https://purecss.io/) was created by the [Pure CSS](https://github.com/pure-css) group.
[**Simple Jekyll Search**](https://github.com/christian-fei/Simple-Jekyll-Search) was created by [Christian Fei](https://github.com/christian-fei).
Various notes and ideas were taken from [**Simply Jekyll**](https://github.com/raghuveerdotnet/simply-jekyll) by [Raghuveer S.](https://github.com/raghuveerdotnet).