Skip to content

Commit

Permalink
add readme and license && prepare for production
Browse files Browse the repository at this point in the history
  • Loading branch information
GodoFredo committed Feb 16, 2017
1 parent 2d0b410 commit d9f3285
Show file tree
Hide file tree
Showing 269 changed files with 6,533 additions and 6,980 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (C) 2017 @GodoFredoNinja

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute,
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
83 changes: 68 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,72 @@

[![Ghost version](https://img.shields.io/badge/Ghost-0.11.x-brightgreen.svg?style=flat-square)](https://ghost.org/)
[![Node version](https://img.shields.io/node/v/uno-zen.svg?style=flat-square)](https://nodejs.org/en/)
[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](http://bit.ly/DonateMapacheGhost)
[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://goo.gl/pE8aEC)

> Simple and Elegant theme for [Ghost](https://github.com/tryghost/ghost/).
### Free theme for Ghost

Hello, I created this theme Ghost inspired by medium. It is available for free so you can use on your site. It is strictly forbidden commercial use. If you have any suggestions to improve the theme, you can send me tweet to [@GodoFredoNinja](http://bit.ly/tw-GodoFredoNinja)

![](./simply-screenshot.png)
Hello, I created this theme for Ghost inspired by [Medium](https://medium.com/).
It is available for free so you can use on your site. It is strictly forbidden commercial use. If you have any suggestions to improve the theme, you can send me tweet to [@GodoFredoNinja](https://goo.gl/y3aivK)

#### 😃 To continue updating the theme with many improvements, I hope a collaboration of ❤ heart through [Paypal](https://goo.gl/pE8aEC)
[![](./donate.gif)](https://goo.gl/pE8aEC)

---

> ⚠️ *Use this theme for ghost under your own responsibility.
Because I am not responsible if [Medium](https://medium.com/) makes you a claim for copyright on the design.*

![](./screenshot.png)

## Demo
You can see a demo in my [blog](http://bit.ly/GodoFredoNinja-blog).

## Featured
- Responsive layout
- Blog navigation
- Page 404 (Multiple faces emoticons)
- Page subscribe
- Pagination Infinite Scroll
- Cover images for blog, tag and author
- links to followers in social media
- Related Articles (3 articles)
- Video Post Format => add tag `#video-post-format`
- Image post Format => add tag `#image-post-format`
- 3 articles featured in the home page
- 5 articles latest posts in the (author - tag) section sidebar
- Previous and next button in the Post
- Has button to save the link on facebook
- Support for comments (Facebook or Disqus)
- Support for counter comments (Facebook or Disqus)
- Buttons to share the article
- Counter shared articles on Facebook
- Additional sticky content in the sidebar
- YouTube, Vimeo, kickstarter -> Video Responsive
- Code syntax [Prismjs](http://prismjs.com/index.html#languages-list) Supported all syntax.

> **To have the best design is recommended to have 14 articles per page.**
## Simply Support for Web Browsers
Mapache supports the following web [browsers](http://caniuse.com/#search=flexbox)

### Replace Favorite Icon
Create an image icon with these dimensions with the name icon.png `192px * 192px` in Copy your new favorite icon to `./assets/images/icon.png`

## Theme development

Simply uses [Webpack](https://webpack.github.io/) as a build tool and [npm](https://www.npmjs.com/) to manage front-end packages.

### Font Icons
Icons generated by [Icomoon](https://icomoon.io/app/#/select) and import `src/fonts/selection.json`

### Install dependencies

From the command line on your host machine (not on your Vagrant development box), navigate to the theme directory then run `yarn`:

```shell
# @ example.com/content/themes/your-theme-name
# @ themes/simply
$ yarn
```

Expand All @@ -40,7 +86,7 @@ You now have all the necessary dependencies to run the build process.

### Using Browsersync

To use Browsersync you need to update `devUrl` at the bottom of `assets/config.json` to reflect your local development hostname.
To use Browsersync you need to update `devUrl` at the bottom of `src/config.json` to reflect your local development hostname.

If your local development URL is `https://project-name.dev`, update the file to read:
```json
Expand All @@ -49,17 +95,9 @@ If your local development URL is `https://project-name.dev`, update the file to
...
```

update `publicPath` to reflect your folder structure:

```json
...
"publicPath": ""
...
```

By default, Browsersync will use webpack's [HMR](https://webpack.github.io/docs/hot-module-replacement.html), which won't trigger a page reload in your browser.

If you would like to force Browsersync to reload the page whenever certain file types are edited, then add them to `watch` in `assets/config.json`.
If you would like to force Browsersync to reload the page whenever certain file types are edited, then add them to `watch` in `src/config.json`.

```json
...
Expand All @@ -70,3 +108,18 @@ If you would like to force Browsersync to reload the page whenever certain file
],
...
```

## Documentation
To continue with the configuration [read](https://github.com/GodoFredoNinja/simply)

### Credits
- [Normalize](https://necolas.github.io/normalize.css/)
- [Jquery.ghostHunter](https://github.com/jamalneufeld/ghostHunter)
- [Prismjs](http://prismjs.com/)
- [sticky-kit](https://github.com/leafo/sticky-kit)
- [lunr.js](https://github.com/olivernn/lunr.js)
- [Fonts](https://fonts.google.com/?selection.family=Droid+Serif:400,700|Source+Code+Pro|Source+Sans+Pro:300,400,600,700&query=Droid+Serif)

## Copyright & License

Copyright (c) 2017 GodoFredoNinja - Released under the [MIT license](LICENSE).
8 changes: 8 additions & 0 deletions assets/assets.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"fonts/simply.eot?b9w9k4": "fonts/simply_4dbf3699.eot",
"fonts/simply.svg?b9w9k4": "fonts/simply_fde7570b.svg",
"fonts/simply.ttf?b9w9k4": "fonts/simply_f806d6b5.ttf",
"images/avatar.png": "images/avatar_65d227a8.png",
"styles/main.css": "styles/main_4f17f508.css",
"scripts/main.js": "scripts/main_4f17f508.js"
}
Loading

0 comments on commit d9f3285

Please sign in to comment.