Skip to content

Commit

Permalink
Merge pull request #5 from zdharma-continuum/ci/gh-action-lint-workflow
Browse files Browse the repository at this point in the history
feat: add lint gh action workflows
  • Loading branch information
vladdoster authored Apr 14, 2023
2 parents 1e45fb0 + 8f58763 commit 1000410
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 27 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Lint

on:
pull_request:
branches: [main, master]
push:
branches: [main, master]
tags: ["v*.*.*"]
workflow_dispatch:

jobs:
commit:
uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main
lint:
uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here
![Tale screenshot](http://i.imgur.com/pXZrtmo.png)

## Features

- Easy installation
- Compatible with GitHub Pages
- Responsive design (looks just as good on mobile)
Expand All @@ -15,13 +16,15 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here
- Pagination of posts

## Installation

There are 3 ways to install this theme

1. Install it as a Ruby Gem (for self-hosted sites)
2. Install it with the `jekyll-remote-theme` plugin (for GitHub Pages hosted sites)
3. Fork the project directly
1. Install it with the `jekyll-remote-theme` plugin (for GitHub Pages hosted sites)
1. Fork the project directly

### Ruby Gem method

1. Add this line to your `Gemfile`:

```ruby
Expand All @@ -37,23 +40,24 @@ $ bundle
3. In `_config.yml` add these lines:

```yaml
theme: tale
theme: tale

permalink: /:year-:month-:day/:title
paginate: 5
permalink: /:year-:month-:day/:title
paginate: 5
```
Remove any other `theme:` lines.

4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.

5. In `about.md`, change the `layout:` field to `post`:
1. In `about.md`, change the `layout:` field to `post`:

```Markdown
layout: post
```

### GitHub Pages method

1. Add these 2 lines in to your `Gemfile`:

```ruby
Expand All @@ -72,8 +76,8 @@ $ bundle
```yaml
remote_theme: chesterhow/tale
permalink: /:year-:month-:day/:title
paginate: 5
permalink: /:year-:month-:day/:title
paginate: 5
plugins:
- jekyll-paginate
Expand All @@ -84,25 +88,28 @@ Remove any other `theme:` or `remote_theme:` lines.

4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.

5. In `about.md`, change the `layout:` field to `post`:
1. In `about.md`, change the `layout:` field to `post`:

```Markdown
layout: post
```

### Fork method

1. Fork this repository

2. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec`
1. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec`

3. Delete the `baseurl` line in `_config.yml`:
1. Delete the `baseurl` line in `_config.yml`:

```yaml
baseurl: "/tale" # delete this line
baseurl: /tale # delete this line
```

## Usage
Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating `_config.yml` with your site's details.

Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating
`_config.yml` with your site's details.

To build and serve your site, run:

Expand All @@ -113,7 +120,9 @@ $ bundle exec jekyll serve
And you're all set! Head over to http://127.0.0.1:4000/ to see your site in action.

## Contributing

Found a bug or have a suggestion? Feel free to create an issue or make a pull request!

## License

See [LICENSE](https://github.com/chesterhow/tale/blob/master/LICENSE)
22 changes: 8 additions & 14 deletions about.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
---
layout: post
title: "About"
author: "psprint"
permalink: /about/
---
______________________________________________________________________

A blog about development of Zshell projects. In **2016**, I did **3152**
commits in total. That is **8.7** commits a day. In **2017**, it was **2737**
commits, it is **7.5** commits a day. Not excluding holidays. Check my Github
profile to obtain confirmation for those numbers:
[https://github.com/psprint](https://github.com/psprint). All code was for
Zshell or indirectly associated with Zshell.
## layout: post title: "About" author: "psprint" permalink: /about/

I have more ideas for projects and features, I hope I maintain the **~8**
commits a day pace thanks to the donations.
A blog about development of Zshell projects. In **2016**, I did **3152** commits in total. That is **8.7** commits a
day. In **2017**, it was **2737** commits, it is **7.5** commits a day. Not excluding holidays. Check my Github profile
to obtain confirmation for those numbers: [https://github.com/psprint](https://github.com/psprint). All code was for
Zshell or indirectly associated with Zshell.

I have more ideas for projects and features, I hope I maintain the **~8** commits a day pace thanks to the donations.

Thanks for reading!

0 comments on commit 1000410

Please sign in to comment.