From 6d7ca6a251fcf9aa4f4b71dd52b59a324b008e16 Mon Sep 17 00:00:00 2001 From: sujaykundu777 Date: Wed, 29 Apr 2020 12:56:14 +0530 Subject: [PATCH] updated docs --- .gitignore | 18 ++++++---- README.md | 17 ++++----- _layouts/about-me.html | 1 + _sass/devlopr.scss | 77 ++++++++++++++++++++++++++++++++++++++-- about.html | 3 -- assets/css/main.scss | 69 ------------------------------------ install.md | 80 ++++++++++++++++++++---------------------- 7 files changed, 134 insertions(+), 131 deletions(-) delete mode 100644 about.html diff --git a/.gitignore b/.gitignore index 79027fad3..431bc1e9f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,14 @@ *.gem -.bundle -.sass-cache -_site -.jekyll-cache + +# Ignore metadata generated by Jekyll +build/ +_site/ +.sass-cache/ +.jekyll-cache/ .jekyll-metadata -vendor -build/ \ No newline at end of file + +# Ignore folders generated by Bundler + +.bundle +.bundle/ +vendor/ \ No newline at end of file diff --git a/README.md b/README.md index df5c3f186..8f68ab13f 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,14 @@ ### devlopr-jekyll - A Jekyll Theme Built for Developers +[![Gem Version](https://badge.fury.io/rb/devlopr.svg)](https://badge.fury.io/rb/devlopr)![workflow-badge](https://github.com/sujaykundu777/devlopr-jekyll/workflows/deploy/badge.svg) +[![Netlify Status](https://api.netlify.com/api/v1/badges/4232ac2b-63e0-4c78-92e0-e95aad5ab8c3/deploy-status)](https://app.netlify.com/sites/devlopr/deploys) +![](https://ruby-gem-downloads-badge.herokuapp.com/devlopr?type=total&color=brightgreen&style=plastic) + Just a little something I'm using to jump start a site refresh. I like to think of it as a starter for building your own Jekyll site. I purposely keep the styling minimal and bare to make it easier to add your own flare and markup. The Theme supports both Light and Dark Style. Highly Customizable and No Hosting or Maintainence Cost is required ! -[Get Started](https://devlopr.netlify.com/get-started) +#### [Installation Guide](https://devlopr.netlify.app/get-started) ![devlopr jekyll](https://github.com/sujaykundu777/devlopr-jekyll/blob/master/assets/img/screenshot.PNG?raw=true) @@ -15,10 +19,6 @@ You can easily manage the site using the admin : [http://localhost:4000/admin](h ![jekyll admin](https://github.com/sujaykundu777/devlopr-jekyll/blob/master/assets/img/jekyll-admin.PNG?raw=true) -[![Gem Version](https://badge.fury.io/rb/devlopr.svg)](https://badge.fury.io/rb/devlopr)![workflow-badge](https://github.com/sujaykundu777/devlopr-jekyll/workflows/deploy/badge.svg) -[![Netlify Status](https://api.netlify.com/api/v1/badges/4232ac2b-63e0-4c78-92e0-e95aad5ab8c3/deploy-status)](https://app.netlify.com/sites/devlopr/deploys) -![](https://ruby-gem-downloads-badge.herokuapp.com/devlopr?type=total&color=brightgreen&style=plastic) - ### Deploy your devlopr-jekyll blog - One Click Deploy [![Deploy with ZEIT Now](https://zeit.co/button)](https://zeit.co/new/project?template=https://github.com/sujaykundu777/devlopr-jekyll) @@ -38,7 +38,8 @@ You can easily manage the site using the admin : [http://localhost:4000/admin](h - CMS Admin Support using [Jekyll Admin](https://jekyll.github.io/jekyll-admin/) - Supports Latest [Jekyll 4.x](https://jekyllrb.com) and [Bundler](https://bundler.io) - Stylesheet built using Sass -- SEO, Google Adsense and Analytics Optimized +- Comments using [Hyvor](https://talk.hyvor.com/) and [Disqus](https://disqus.com/) +- Google SEO and Analytics Optimized - Real Time Search using [Algolia](https://algolia.com/) - Sell Stuff (Ecommerce) in your Blog using [Snipcart](https://snipcart.com/) - Send Newsletters using [Mailchimp](https://mailchimp.com/) @@ -46,10 +47,6 @@ You can easily manage the site using the admin : [http://localhost:4000/admin](h - Coding Activity using [Wakatime](https://wakatime.com/) - Hosting Support for [Github Pages](https://pages.github.com), [Netlify](https://netlify.com), [Zeit](https://zeit.co), [Heroku](https://heroku.com), [AWS Amplify](aws.amplify.com) -### Using non-supported Jekyll Plugins (For Github Pages): - -You can use this [deploy-jekyll-site](https://github.com/marketplace/actions/deploy-jekyll-site) action to build the site and use custom or non-supported jekyll plugins - ## Using Docker : Building the Image : diff --git a/_layouts/about-me.html b/_layouts/about-me.html index a8ba7ca91..fc3d74a15 100644 --- a/_layouts/about-me.html +++ b/_layouts/about-me.html @@ -137,6 +137,7 @@
{{ project.project_info}}

+
{% endif %} {% endfor %} {% endif %} {% if site.show_author_work_experiences == true %} diff --git a/_sass/devlopr.scss b/_sass/devlopr.scss index 68bab4bc7..422d87a31 100644 --- a/_sass/devlopr.scss +++ b/_sass/devlopr.scss @@ -421,6 +421,75 @@ header { width: 0; } + +/* Homepage project cards*/ + +#project-card{ + margin: 0px !important; +} +#article{ + margin-left: 35px !important; + margin-top: 20px !important; +} +.project_thumbnail{ + text-align: center; +} +.project-img{ + width:150px; + height:100px; +} +.project_details{ + padding: 10px; +} +.project_links { + margin: 4px; + padding-top: 32px; + padding-left: 50px !important; +} + +#blog-posts-container{ + margin-left:20px !important; +} + +#article-container{ + display: grid; + width: 100%; + grid-template-columns: 1fr 7fr 4fr; +} + +#recent-articles,#recent-projects{ + margin-top: 100px !important; +} + +#recent-articles-header{ + display: grid; + width: 100%; + grid-template-columns: 17fr 2fr; +} +#article-img, #article-link, #article-alert{ + padding-left: 10px; + padding-top: 10px; + margin: 4px; +} +.recent-article-link{ + font-size: 20px; + text-decoration: none; +} +.article-card-link, .article-card-link:hover{ + text-decoration: none; + color: orange !important; +} +.article-card{ + list-style-type: none; +} +.article-card a :hover{ + text-decoration: none; + background: #303030!important; + border-color: #303030; + background: transparent; +} + + @media (min-width: 768px) { .offset-md-1 { margin-left: 3.333333% !important; @@ -450,7 +519,7 @@ header { margin-top: 5px; } .social-link { - color: var(--social-link-color); + color: var(--social-link-color) !important; font-size: 15px; padding: 5px; margin: 2px; @@ -630,7 +699,6 @@ footer { font-size: 1.25rem; line-height: inherit; white-space: nowrap; - margin-left: -80px; } .jumbotron { @@ -744,6 +812,11 @@ footer { } } + #topNav { + padding-left: 0px; + padding-right: 0px; + } + #mc-embedded-subscribe-form { width: 100%; padding: 50px; diff --git a/about.html b/about.html deleted file mode 100644 index c93e4fde2..000000000 --- a/about.html +++ /dev/null @@ -1,3 +0,0 @@ ---- -layout: about-me ---- diff --git a/assets/css/main.scss b/assets/css/main.scss index 2ff72d44e..4e5e52d29 100644 --- a/assets/css/main.scss +++ b/assets/css/main.scss @@ -6,72 +6,3 @@ @import "devlopr"; /* custom css goes below */ - -/* custom css goes below */ - -/* Homepage project cards*/ - -#project-card{ - margin: 0px !important; -} -#article{ - margin-left: 35px !important; - margin-top: 20px !important; -} -.project_thumbnail{ - text-align: center; -} -.project-img{ - width:150px; - height:100px; -} -.project_details{ - padding: 10px; -} -.project_links { - margin: 4px; - padding-top: 32px; - padding-left: 50px !important; -} - -#blog-posts-container{ - margin-left:20px !important; -} - -#article-container{ - display: grid; - width: 100%; - grid-template-columns: 1fr 7fr 4fr; -} - -#recent-articles,#recent-projects{ - margin-top: 100px !important; -} - -#recent-articles-header{ - display: grid; - width: 100%; - grid-template-columns: 17fr 2fr; -} -#article-img, #article-link, #article-alert{ - padding-left: 10px; - padding-top: 10px; - margin: 4px; -} -.recent-article-link{ - font-size: 20px; - text-decoration: none; -} -.article-card-link, .article-card-link:hover{ - text-decoration: none; - color: orange !important; -} -.article-card{ - list-style-type: none; -} -.article-card a :hover{ - text-decoration: none; - background: #303030!important; - border-color: #303030; - background: transparent; -} diff --git a/install.md b/install.md index 0ef9bcb9e..60b411bea 100644 --- a/install.md +++ b/install.md @@ -1,15 +1,13 @@ --- -title: Get Started +title: Get Started menus: header layout: page permalink: /get-started/ --- -## Getting Started - How to create your blog using devlopr-jekyll +## Getting Started - Deploying your blog using devlopr-jekyll -This guide is for deploying devlopr-jekyll blog using Github Pages, If you want to switch to any other Deployment Providers. We have deployment guides below ! - -Steps to create your blog using devlopr-jekyll: +Steps to create your blog using devlopr-jekyll and Host using Github Pages : > **Step 1.** Fork the repo - [click here](https://github.com/sujaykundu777/devlopr-jekyll/fork) @@ -30,7 +28,7 @@ Steps to create your blog using devlopr-jekyll: ![Devlopr Jekyll Repo](/assets/img/posts/fork33.png){:class="img-fluid"} -``` +```bash $ git clone https://github.com/yourusername/yourusername.github.io $ cd yourusername.github.io $ code . @@ -57,37 +55,59 @@ We need ruby and bundler to build our site locally. After installation check if For ruby : -``` - $ ruby -v - ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu] +```bash +$ ruby -v +ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu] ``` For bundler : - ``` - $ bundler -v - Bundler version 2.0.1 - ``` +```bash +$ bundler -v +Bundler version 2.1.4 +``` +Add jekyll : + +```bash +$ bundle add jekyll +``` + This command will add the Jekyll gem to our Gemfile and install it to the ./vendor/bundle/ folder. + +You can check the jekyll version + +``` +$ bundle exec jekyll -v +jekyll 4.0.0 +``` > **Step 6.** Install the gem dependencies by running the following command -`$ bundle update` -`$ bundle install` +```bash +$ bundle update +$ bundle install +``` > **Step 7.** Serve the site locally by running the following command below: -`$ jekyll serve` +```bash +$ bundle exec jekyll serve +``` +or you can also serve using : -![Devlopr Jekyll Repo](/assets/img/posts/fork4.png){:class="img-fluid"} +```bash +$ jekyll serve +``` Visit [http://localhost:4000](http://localhost:4000) for development server +![Devlopr Jekyll Repo](/assets/img/posts/fork4.png){:class="img-fluid"} + ![Devlopr Jekyll Repo](/assets/img/posts/fork41.png){:class="img-fluid"} Once happy with your blog changes. Push your changes to master branch. > **Step 8.** Push Your Local Changes -``` +```bash $ git add . $ git commit -m "my new blog using devlopr-jekyll" $ git push origin master @@ -101,29 +121,7 @@ Visit your Github Repo settings ! Enable master branch as Github Pages Branch : ![Devlopr Jekyll Repo](/assets/img/posts/fork7.png){:class="img-fluid"} - -Check the Deployment Guides Below : - -- [Deploy using Github Pages using Github Actions](https://sujaykundu.com/blog/post/deploy-jekyll-using-github-pages-and-github-actions#/) -- [Deploy using Github Pages using Travis](https://sujaykundu.com/blog/posts/deploy-jekyll-blog-using-github-pages-and-travis-ci/#/) -- Deploy using Zeit Now -- Deploy using Netlify -- Deploy using Heroku -- Deploy using AWS Amplify -- Deploy using CloudCannon - -> **Step 10**. Connecting to a Headless CMS (Content Management System): - -You can use the below Headless CMS services to manage content on your blog seemlessly. - -- Using Jekyll Admin -- Using Forestry CMS -- Usign Siteleaf CMS -- Using CloudCannon CMS -- Using Contentful - > Congrats ! On your new shining Blog ! -You can visit the blog using [http://your-github-username.github.io](http://your-github-username.github.io) (in case of hosting using github pages). The url may vary depending on your Deployment provider. - +You can visit the blog using [http://your-github-username.github.io](http://your-github-username.github.io).