Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dev-mdirfan/inkstream
Inkstream: A Jekyll theme for seamless and continuous blogging, embodying the fluidity of ink in the art of writing.
https://github.com/dev-mdirfan/inkstream
github-pages jamstack jekyll jekyll-theme netlify ruby-gem theme
Last synced: 25 days ago
JSON representation
Inkstream: A Jekyll theme for seamless and continuous blogging, embodying the fluidity of ink in the art of writing.
- Host: GitHub
- URL: https://github.com/dev-mdirfan/inkstream
- Owner: dev-mdirfan
- License: mit
- Created: 2024-02-04T16:53:33.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-02-06T08:51:57.000Z (9 months ago)
- Last Synced: 2024-09-29T02:41:27.911Z (about 1 month ago)
- Topics: github-pages, jamstack, jekyll, jekyll-theme, netlify, ruby-gem, theme
- Language: JavaScript
- Homepage: https://inkstream.netlify.app/
- Size: 23.6 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Inkstream [](https://badge.fury.io/rb/inkstream)
Welcome to a brand new Jekyll theme!
**What Is Inkstream?**
Inkstream is a Jekyll theme for creating a personal blogging, embodying the fluidity of ink in the art of writing. It is designed to be a simple, clean, and responsive theme for your personal blog.
Preview the theme to see what it looks like, or even use it today. You can also view the theme's [live demo](https://inkstream.netlify.app/).
| Home | Blog |
|:---:|:---:|
|  |  |
**Features**
- Clean and minimal design
- Responsive and mobile-friendly
- Syntax highlighting
- Pagination
- Atom feed
**Directory Structure**
```plaintext
inkstream
├── _includes
├── _layouts
├── _sass
├── assets
└── _config.yml
```
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "inkstream"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: inkstream
```
And then execute:
```bash
bundle
```
Or install it yourself as:
```bash
gem install inkstream
```
## Usage
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dev-mdirfan/inkstream. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.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 `inkstream.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).