Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samarsault/texture
A configurable jekyll theme for simply beautiful blogs.
https://github.com/samarsault/texture
configurable-theme jekyll theme
Last synced: 2 days ago
JSON representation
A configurable jekyll theme for simply beautiful blogs.
- Host: GitHub
- URL: https://github.com/samarsault/texture
- Owner: samarsault
- License: mit
- Created: 2019-06-29T14:05:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T04:42:02.000Z (6 months ago)
- Last Synced: 2024-12-14T02:05:38.656Z (9 days ago)
- Topics: configurable-theme, jekyll, theme
- Language: SCSS
- Homepage: https://samarsault.com/texture
- Size: 1.9 MB
- Stars: 221
- Watchers: 3
- Forks: 341
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# texture
A configurable jekyll theme for simply beautiful blogs.
**Demo**: [samarsault.com/texture](https://samarsault.com/texture)
## Installation on Github Pages
Add this line to your site's `_config.yml`:
```yaml
remote_theme: samarsault/texture
```
**NOTE: If you are forking this repo, remove `base_url: /texture` in the `_config.yml` which is required to load the required website assets**
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "texture"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: texture
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install texture
## Usage
The "texture" key in _config.yml is used to customize the theme data.
```yaml
texture:
title: Adam Denisov
tagline: Developer. Designer
date_format: "%b %-d, %Y"
social_links:
twitter: thelehhman
github: thelehhman
linkedIn: in/thelehhman # format: locale/username
```
**Styling**
Multiple header styles are supported using the "style" property under texture in `_config.yml`.
```yaml
texture:
style: [yellow|red|black|blue|green|purple]
```
For example, the blue style looks like this:
**Texture Picker**
You can toggle the texture picker to show/experiment various textures on your site using the showPicker variable. Remember to make it `false` for production.
```yaml
texture:
showPicker: [false|true] # show the texture selector(development purposes)
```
**Comments (Disqus)**
Comments on posts can be enabled by specifying your disqus_shortname under texture in `_config.yml`. For example,
```yaml
texture:
disqus_shortname: games
```
**Google Analytics**
It can be enabled by specifying your analytics id under texture in `_config.yml`
```yaml
texture:
analytics_id: '< YOUR ID >'
```
**Excerpts**
Excerpts can be enabled by adding the following line to your `_config.yml`
```yaml
show_excerpts: true
```
**Toggle Navbar**
```yaml
texture:
showNav: true
```
**Navigation**
After setting `showNav` to true navigation can be built by adding the following to your `_config.yml`
```yaml
texture:
navigation:
- title: My Work
url: "/my-work"
- title: Resume
url: "/resume"
```
**Layouts**
- Home
- Page
- Post
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/samarsault/texture. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `texture.gemspec` accordingly.
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
[](https://paypal.me/thelehhman)
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## More Themes
[plainwhite](https://github.com/samarsault/plainwhite-jekyll)