Skip to content

Commit

Permalink
Merge branch 'dev' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
godofredoninja committed Feb 23, 2021
2 parents d5f89a6 + aebcf4a commit cc21e3c
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 7 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
custom: ['https://www.paypal.me/godofredoninja']
open_collective: simply
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing

:smile: Thank you for contributing to Simply!

## Development

Simply uses [Gulp](https://gulpjs.com/) as a build tool and [Yarn](https://yarnpkg.com/) to manage front-end packages.

```bash
# clone this repo
$ git clone https://github.com/godofredoninja/simply.git

# Use branch Dev
$ git checkout dev

# install the dependencies
$ cd simply/src && yarn

# run build & livereload task
$ yarn dev

# link to ghost themes dir
$ ln -s $PWD path/to/ghost/content/themes/simply

# restart ghost server
$ cd path/to/ghost && ghost restart --development
```

### Icons

[Ionicons](https://github.com/ionic-team/ionicons) and generated by [Icomoon](https://icomoon.io/app/#/select) after import `src/svg-icons/selection.json`

### Build commands

- `yarn dev` — Compile assets when file changes are made, start [livereload](http://livereload.com/)
- `yarn build` — Compile and optimize the files in your assets directory
- `yarn prod` — Compile assets for production and generate a `dist/simply.zip`

### Additional commands

- `yarn lint:js`[Standard](https://standardjs.com/), Check for errors in the script.
- `yarn lint:sass`[Stylelint](https://stylelint.io/), Check for errors in the styles.
- `yarn lint` — Check error in script and styles.
- `yarn scan`[Ghost Scan](https://github.com/TryGhost/gscan) check for errors, deprecation and other compatibility issues.
- `yarn test` — Check the script errors and styles then check the theme if it is compatible with the latest version of Ghost.

## Git/GitHub workflow

This is our preferred process for opening a PR on GitHub:

1. Fork this repository
2. Create a branch off of `dev` for your work: `git checkout -b my-feature-branch`
3. Make some changes, committing them along the way
4. When your changes are ready for review, push your branch: `git push origin my-feature-branch`
5. Create a pull request from your branch to `simply/dev`
6. No need to assign the pull request to anyone, we'll review it when we can
7. When the changes have been reviewed and approved, someone will squash and merge for you
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,16 @@
<img src="https://user-images.githubusercontent.com/10253167/103450308-a2757c00-4c82-11eb-8bc3-29b09520fc58.png" width="150px" alt="Simply free theme for Ghost" />
</a>
</p>

<p align="center">
<a href="https://godofredo.ninja/ghost-theme/simply/introduction">Docs</a> |
<a href="https://godofredo.ninja/ghost-theme/showcase/">Showcase</a> |
<a href="https://github.com/godofredoninja/simply/graphs/contributors">Contributing</a> |
<a href="https://www.paypal.me/godofredoninja">PayPal</a> |
<a href="https://godofredo.ninja/ghost-theme/simply/introduction">Docs</a>
·
<a href="https://godofredo.ninja/ghost-theme/showcase/">Showcase</a>
·
<a href="https://github.com/godofredoninja/simply/graphs/contributors">Contributing</a>
·
<a href="https://www.paypal.me/godofredoninja">PayPal</a>
·
<a href="https://twitter.com/godofredoninja">Twitter</a>
<br /><br />
<a href="https://github.com/TryGhost/Ghost">
Expand All @@ -16,17 +21,19 @@
<a href="https://www.paypal.me/godofredoninja">
<img src="https://img.shields.io/badge/donate-paypal-blue.svg" alt="Donate" />
</a>
<a href="https://www.buymeacoffee.com/GodoFredoNinja">
<img src="https://img.shields.io/badge/-Buy%20Me%20A%20Coffee-%23FF813F" alt="Buy Me A Coffee" />
<a href="https://opencollective.com/simply">
<img src="https://opencollective.com/simply/tiers/badge.svg" alt="opencollective" />
</a>
</p>

<p align="center">
Hello :sunglasses:
<br />
I created this theme for <a href="https://github.com/tryghost/ghost/">Ghost</a> with inspiration from <a href="https://medium.com/">Medium</a>.
<br />
It is available for free so you can use on your site.
</p>

<p align="center">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Y7UB5Q8GVN3HN&source=url">
<img src="https://user-images.githubusercontent.com/10253167/103444000-877b1b80-4c32-11eb-8377-7bedd46dbdf8.gif" alt="donate" />
Expand Down Expand Up @@ -94,6 +101,39 @@
- Medium style image zoom
- [Prism supported all syntax](https://prismjs.com/index.html#supported-languages)

## Contributing

Im always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/godofredoninja/simply/labels/%F0%9F%8C%B1%20good%20first%20issue).

I greatly appreciate any help in maintaining to keep the documentation up to date. My English is not so good and I am trying to make the documentation more understandable.

If you are interested in collaborating with Simply, take a look at the [Contributing Guide](https://github.com/godofredoninja/simply/blob/master/CONTRIBUTING.md).

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](https://github.com/godofredoninja/simply/blob/master/CONTRIBUTING.md)].

[![Simply Contributors](https://opencollective.com/simply/contributors.svg?width=890&button=false)](https://github.com/godofredoninja/simply/graphs/contributors)

### Financial Contributors

First I want to say thank you with all my heart and a million more Thank you. The [donation](https://www.paypal.me/godofredoninja) you have made has motivated me to continue working with the improvement and updating the theme.

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/simply/contribute)]

- [CMS Critic](http://www.cmscritic.com/) :star: :star: :star: :star:
- [A Boundless World](https://www.aboundlessworld.com/) :star: :star:
- [Dana Ross](https://vaalin.com/)
- Greg Rapp
- Yannick Kordel
- Bruno Brito Semedo
- Ivan Rodriguez Segura
- Rodrigo Franken Dutra
- Diego Alcantara Zweifel
- Andrew Wagner

[![Individuals Financial](https://opencollective.com/simply/individuals.svg?width=890)](https://opencollective.com/simply)

## Credits

- [Hodor AMP](https://github.com/godofredoninja/Hodor-AMP-Ghost)
Expand Down
2 changes: 1 addition & 1 deletion custom-kusi-doc.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</div>

{{!-- content of the documentation --}}
<article class="md:py-12 flex-grow">
<article class="py-4 md:py-12 flex-grow">
<div class="max-w-2xl mx-auto md:px-4">
<header><h1 class="text-title">{{title}}</h1></header>

Expand Down

0 comments on commit cc21e3c

Please sign in to comment.