Skip to content

Commit

Permalink
Fixed readme images
Browse files Browse the repository at this point in the history
  • Loading branch information
raghudotcc committed Jun 7, 2021
1 parent 61a02d8 commit 23832de
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 47 deletions.
103 changes: 56 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
## Simply Jekyll - A simple jekyll theme

[![Netlify Status](https://api.netlify.com/api/v1/badges/42c75d17-5f01-4aea-9da3-4538ba92122e/deploy-status)](https://app.netlify.com/sites/simply-jekyll/deploys)
<p align="right">
<a href="https://jekyll-themes.com">
<img src="https://img.shields.io/badge/featured%20on-JT-red.svg" height="20" alt="Jekyll Themes Shield" >
</a>

![simply_jekyll](./assets/img/../../../_site/assets/img/logo.png)
</p>
<br><br>


Simply Jekyll is a simple yet highly functional jekyll-based theme that combines the best of different worlds. It is a minimal and distraction free theme that strives to provide maximum value all without holding back on any essential features that a user would benefit from or would desire for. This is an evolving project and is garanteed to be maintained at least for quite some time as I myself am a beneficiary of this theme and the project.
<p align="center">
<p align="center">
<img width="250px" src="./assets/img/logo.png">
</p><hr>
<p align="center">Simply Jekyll is a simple yet highly functional jekyll-based theme that combines the best of different worlds. It is a minimal and distraction free theme that strives to provide maximum value all without holding back on any essential features that a user would benefit from or would desire for. This is an evolving project and is garanteed to be maintained at least for quite some time as I myself am a beneficiary of this theme and the project.</p>
<p align="center"><strong><a href="https://simply-jekyll.netlify.app/">See it in action!</a></strong></p>
<br><br><br>
</p>

Preview the template here: [Simply-Jekyll](https://simply-jekyll.netlify.app/)
<p align="center">
<img src="./assets/img/end_result.png">
</p>

I wrote a tutorial explaining how to set it up: ["How to setup simply-jekyll"](https://simply-jekyll.netlify.app/posts/setup)
## Feature Overview

### Feature Overview
[View the documentation(f)](https://simply-jekyll.netlify.app/posts/explore) for feature information.

- Based on Jekyll, a static website generator
- Creates backlinks to other notes automatically
Expand All @@ -26,41 +33,43 @@ I wrote a tutorial explaining how to set it up: ["How to setup simply-jekyll"](h
- Supports Markdown or HTML notes


<table>
<tr>
<th><b>Feed Structure</b></th>
<th><b>Linked References(Backlinks)</b></th>
<th><b>Context Menu</b></th>
</tr>

<tr>
<td><img alt="feed" src="./assets/img/feed.png" /></td>
<td><img alt="backlinks" src="./assets/img/backlinks.png" /></td>
<td><img alt="contextmenu" src="./assets/img/context_menu.png" /></td>
</tr>

<tr>
<th><b>Profile Board</b></th>
<th><b>Search with Context</b></th>
<th><b>Header w/ Profile</b></th>
</tr>

<tr>
<td><img alt="profile" src="./assets/img/profile_board.png" /></td>
<td><img alt="search" src="./assets/img/search_with_preview.png" /></td>
<td><img alt="profileless" src="./assets/img/site_without_profile.png" /></td>
</tr>

<tr>
<th><b>Transclusion</b></th>
<th><b>Highlighting</b></th>
<th><b>Pagepreview</b></th>
</tr>

<tr>
<td><img alt="transclusion" src="./assets/img/transclusion.JPG" /></td>
<td><img alt="highlighting" src="./assets/img/highlighting.JPG" /></td>
<td><img alt="pagepreview" src="./assets/img/pagepreview.png" /></td>
</tr>

</table>
## Installation

[View the documentation(i)](https://simply-jekyll.netlify.app/posts/setup) for setup and installation information.

Hopefully there will be an easier process soon.

## Usage

[View the documentation(u)](https://simply-jekyll.netlify.app/posts/usage) for usage information.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/raghuveerdotnet/simply-jekyll. 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.

### Submitting code changes:

- Open a [Pull Request](https://github.com/raghuveerdotnet/simply-jekyll/pulls)
- Ensure all CI tests pass
- Await code review

### Design and development principles of this theme:

1. As few dependencies as possible
2. No build script needed
3. First class mobile experience
4. Make the content shine

## Development

To set up your environment to develop this theme, run `bundle install`.

Your theme is set up 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 the theme is released, only the files in `_layouts`, `_includes`, and `assets` tracked with Git will be released.

## License

The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).


File renamed without changes.
Binary file modified assets/img/end_result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23832de

Please sign in to comment.