moonwalk 0.0.4 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +40 -33
  3. data/_config.yml +5 -1
  4. data/_includes/date_and_social_share.html +1 -2
  5. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7e270dfe2fbc981a4e282452fe0e19234b064cbdf98f048df6b63ea07d8a785c
4
- data.tar.gz: c189daf8b600ca2f7bcfeaa26619ab73727bb70abd069aa9f9c1b4c6b2a2b54f
3
+ metadata.gz: '090356e88da17ad90e7f88cd8104eb23401d4d92412f93f82c476f51b482d628'
4
+ data.tar.gz: ebc009042c02bf50123f36040bd8d251eb98b6c72d2c5f78779a7c4cc6815228
5
5
  SHA512:
6
- metadata.gz: d87fc734bad001a7ff65694bdf39de795462778bd2a2b890bbdb53b24601a311b9d8ccc152fe1397d5a9ee1d50cce1199bc42a898cff1a79ec123f1625dc9080
7
- data.tar.gz: 9e47b40287b8f29f5b8f94e67c4f662d673e47a25a2a9bdbfe1640d010a91bfb528ceedbb48b8e065fcafc064d478b2e37355d78e57239016d1cba697db0efaa
6
+ metadata.gz: 6bd9a469b9c503784167fc53872f81dd94ea5bdc51963f67842ffeb856d3402010a2e98f814ce6a4fb007f31e917fa0df35e975673bb8a5d5f408cac904ac942
7
+ data.tar.gz: 146f84a88f20840c4bb45c1322732b2e4f64ffc8ee1a5f23a8f06cc1b381bf34b44925c5f16b65bdc0c5e837afc16335ebe448caf0c2b10711243fe86b78ca4d
data/README.md CHANGED
@@ -1,10 +1,11 @@
1
- # moonwalk
1
+ ## moonwalk - a fast and minimalistic blog theme with clean dark mode
2
2
 
3
- <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/logo.png" width="32" align="left" />A fast and minimalistic blog with clean dark mode. Based on [no style please!](https://riggraz.dev/no-style-please/)
3
+ <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/moonwalk.png" />
4
4
 
5
- <h3 align="center"><a href="https://abhinavs.github.io/moonwalk/">Try the Demo</a></h3>
6
-
7
- <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/moonwalk.jpg" />
5
+ <h3 align="center">
6
+ <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/logo.png" width="24"/>
7
+ <a href="https://abhinavs.github.io/moonwalk/">TRY THE DEMO</a>
8
+ </h3>
8
9
 
9
10
  ## Features
10
11
  * Light & dark mode with theme switcher
@@ -12,47 +13,36 @@
12
13
  * Landing page with navbar, footer, portfolio
13
14
  * Fast (very minimal CSS) - 100/100 on performance, accessibility, best practices and SEO, please see [Lighthouse Report](https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/lighthouse-report.png) for more details
14
15
  * Responsive and mobile friendly
15
- * SEO optimized (uses [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag))
16
+ * SEO optimized (uses [Jekyll Soopr SEO Tag](https://github.com/jekyll/jekyll-soopr-seo-tag))
16
17
  * RSS feed (uses [Jekyll Feed](https://github.com/jekyll/jekyll-feed))
17
18
  * Easy to extend
18
19
  * Fully compatible with [GitHub Pages](https://pages.github.com/) (see [GitHub Pages installation](#github-pages-installation))
20
+ * Auto-generated social media share images (using Soopr)
21
+ * Share & like buttons (using Soopr)
19
22
 
20
23
 
21
24
  #### Lighthouse
22
25
 
23
26
  <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/lighthouse-report.png" />
24
27
 
25
- ## Installation
26
-
27
- If you haven't already created your blog using Jekyll, follow the [instructions](https://jekyllrb.com/docs/) to do so from Jekyll's documentation.
28
-
29
- NOTE: if you are using Jekyll with GitHub Pages, see the [GitHub Pages installation section](#github-pages-installation).
30
-
31
- Then, to style your blog with this theme, add this line to your Jekyll site's `Gemfile`:
28
+ ## Quick Installation
29
+ 1. [Fork this repository](https://github.com/abhinavs/moonwalk/fork).
30
+ 2. `cd moonwalk`
31
+ 3. `bin/bootstrap`
32
+ 4. [Optional] Sign up on Soopr, and add your `publish_token` in `_config.yml` file.
32
33
 
33
- ```ruby
34
- gem "moonwalk"
35
- ```
36
-
37
- And add this line to your Jekyll site's `_config.yml`:
38
-
39
- ```yaml
40
- theme: moonwalk
41
- ```
34
+ ## Starting Server
35
+ `bin/start` - development server will start at http://127.0.0.1:4000
42
36
 
43
- And then execute:
37
+ ## Deployment
38
+ Moonwalk can be easily deployed on all the cloud providers (AWS etc.), and on static website hosting services like Netlify & Vercel. You can also use this button to do one click deploy
39
+ <br />
40
+ <br />
41
+ [![Deploy with Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/abhinavs/moonwalk)
44
42
 
45
- $ bundle
43
+ If you want to use Moonwalk as a gem or use Github Pages, please see [this page](https://github.com/abhinavs/moonwalk/blob/master/github_pages.md)
46
44
 
47
- Or install it yourself as:
48
-
49
- $ gem install moonwalk
50
-
51
- ### GitHub Pages installation
52
-
53
- If you want to use this theme for your Jekyll's site deployed on [GitHub Pages](https://pages.github.com/), follow the instructions on [this page](https://docs.github.com/en/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll#adding-a-theme).
54
-
55
- ## Usage
45
+ ## Customizing
56
46
 
57
47
  You can edit `_config.yml` file to customize your blog. You can change things such as the name of the blog, the author, the appearance of the theme (light, dark or auto), how dates are formatted, etc. Customizable fields should be straightforward to understand. Still, `_config.yml` contains some comments to help you understand what each field does.
58
48
 
@@ -119,6 +109,9 @@ html {
119
109
  };
120
110
  }
121
111
  ```
112
+ 3. Add [Soopr](https://www.soopr.co) `publish_token` in `_config.yml` file to auto generate social share images. You also additionally get Like button and URL shortener, you can control them using Soopr dashboard.
113
+
114
+ <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/twitter_card.png" />
122
115
 
123
116
  ## Contributing
124
117
 
@@ -140,3 +133,17 @@ This theme's original base is [no style please!](https://github.com/riggraz/no-s
140
133
 
141
134
  The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
142
135
 
136
+ ## Other Projects
137
+ If you like Moonwalk, do check out my other projects
138
+ * [cookie](https://github.com/abhinavs/cookie) - a free landing website boilerplate using Jekyll and Tailwind CSS
139
+ * [scoop](https://github.com/abhinavs/scoop) - a Sinatra boilerplate project using Corneal, ActiveRecord, Capistrano, Puma & Nginx
140
+ * [soopr](https://www.soopr.co) - a tool that supports you in content marketing
141
+ * [apicagent](https://www.apicagent.com) - a FREE API that extracts device details from user-agent string
142
+ * [pincodr](https://pincodr.apiclabs.com) - a FREE API for Indian pincodes
143
+ * [humangous](https://www.humangous.co) - create public and private 'working with you' guides
144
+ * [blockr](https://www.abhinav.co/blockr) - a CLI tool to help you easily block and unblock websites
145
+ * [microrequests](https://www.abhinav.co/microrequests) - a Python library to help you consume microservice efficiently
146
+
147
+ ✨⚡You can read more about me on my [blog](https://www.abhinav.co/about/) or follow me on Twitter - [@abhinav](https://twitter.com/abhinav)
148
+
149
+ ✨⚡If you like my work, you can [buy me a coffee](https://buymeacoffee.com/abhinavs)
data/_config.yml CHANGED
@@ -8,6 +8,10 @@ permalink: /:slug.html
8
8
 
9
9
  favicon: "./logo.png" # relative path to site's favicon
10
10
 
11
+ twitter:
12
+ username: abhinav # update or delete this
13
+ card: summary_large_image
14
+
11
15
  #theme: moonwalk # if you are using GitHub Pages, change it to remote_theme: abhinavs/moonwalk
12
16
  remote_theme: abhinavs/moonwalk
13
17
 
@@ -42,4 +46,4 @@ sass:
42
46
 
43
47
  plugins:
44
48
  - jekyll-feed
45
- - jekyll-seo-tag
49
+ - jekyll-soopr-seo-tag
data/_includes/date_and_social_share.html CHANGED
@@ -5,7 +5,6 @@
5
5
  </p>
6
6
 
7
7
  <div class="soopr-btn"
8
- data-twitter="abhinav"
9
- data-facebook="abhinavs"
8
+ data-twitter="SooprCo"
10
9
  >
11
10
  </div>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: moonwalk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Abhinav Saxena
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-21 00:00:00.000000000 Z
11
+ date: 2021-08-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -39,19 +39,19 @@ dependencies:
39
39
  - !ruby/object:Gem::Version
40
40
  version: 0.15.0
41
41
  - !ruby/object:Gem::Dependency
42
- name: jekyll-seo-tag
42
+ name: jekyll-soopr-seo-tag
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 2.7.1
47
+ version: 2.7.3
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 2.7.1
54
+ version: 2.7.3
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: rouge
57
57
  requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
112
112
  - !ruby/object:Gem::Version
113
113
  version: '0'
114
114
  requirements: []
115
- rubygems_version: 3.1.4
115
+ rubygems_version: 3.2.15
116
116
  signing_key:
117
117
  specification_version: 4
118
118
  summary: A fast and minimalist Jekyll theme with clean dark mode.