An open API service indexing awesome lists of open source software.

https://github.com/mervinpraison/artisan-static


https://github.com/mervinpraison/artisan-static

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Artisan Static

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://oss.ninja/mit/raniesantos)
[![donate](https://img.shields.io/badge/$-donate-ff5f5f.svg?style=flat-square)](https://ko-fi.com/raniesantos)

An advanced starter template for building a static Jigsaw blog hosted on Netlify with analytics, comments, code highlighting, a contact form, a CMS, and more.

This template has extremely minimal CSS.

___
## General details and features

- Static site generator: [Jigsaw](http://jigsaw.tighten.co) (Laravel Blade templates)
- Hosting: [Netlify](https://www.netlify.com)
- CMS: [Netlify CMS](https://www.netlifycms.org)
- Image hosting: [Cloudinary](https://cloudinary.com)
- Google Analytics
- Posts can have multiple tags
- Posts show a warning when potentially outdated (over 365 days old)
- Code highlighting: [highlight.js](https://github.com/highlightjs/highlight.js)
- Share buttons: [sharer.js](https://github.com/ellisonleao/sharer.js)
- Facebook Open Graph and Twitter Card meta tags
- Comments: [Disqus](https://disqus.com)
- Contact form: [Jumprock](https://jumprock.co)

___
## Getting started

Use this deploy button to get your own copy of the repository.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/raniesantos/artisan-static&stack=cms)

This button will do the following:

- Connect to your GitHub account and create a new repository with the name you specify
- Deploy your copy of the repository and setup continuous deployment
- Send an invite to the email address associated with your Netlify account

Accept the invite, set your password, then navigate to `/admin` on your site to log in.

Now you're all set, and you can start customizing your static site!

___
## Local development

After using the deploy button above, clone **your copy** of the repository and run:

```shell
$ composer install
$ yarn install
$ yarn watch
```

Your browser will open [localhost:3000](http://localhost:3000/) automatically.

___
## Configuration

The default posts included in this template contain short guides on how to configure or implement some of its features.

When you use the 3rd-party services recommended by this template, make sure to read the docs of that specific service.

___
## License

Released under the [MIT License](https://oss.ninja/mit/raniesantos).