Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sujaykundu777 committed Apr 29, 2020
1 parent 6d7ca6a commit 1a86659
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 18 deletions.
2 changes: 1 addition & 1 deletion _includes/blog_post_article.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<article class="card" itemscope itemtype="http://schema.org/BlogPosting">
<div class="card-header">
<!-- <h1 class="post-title" itemprop="name headline">{{ page.title }}</h1> -->
<h1 class="post-title" itemprop="name headline">{{ page.title }}</h1>
<h4 class="post-meta">{{ page.summary }}</h4>
<p class="post-summary">
Posted by : {% if page.author %}
Expand Down
28 changes: 28 additions & 0 deletions _posts/2019-02-04-welcome-to-jekyll.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: post
title: "Welcome to devlopr !"
summary: Hello World ! This is a sample post
author: John Doe
date: '2019-05-22 14:35:23 +0530'
category: jekyll
thumbnail: code.jpg
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.

Jekyll also offers powerful support for code snippets:

{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}

Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].

[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/
11 changes: 0 additions & 11 deletions _posts/2020-02-14-plugged-in.md

This file was deleted.

3 changes: 2 additions & 1 deletion _sass/devlopr.scss
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,8 @@ header {
width: 400px;
padding: 14px;
color: #111;
border-color: #fff;
border-color: #111;
background: bisque;
text-align: center;
text-transform: capitalize;
border: 1px solid #fff;
Expand Down
13 changes: 13 additions & 0 deletions categories/jekyll.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: page
title: Jekyll
permalink: /blog/categories/jekyll
---

<h5> Posts by Category : {{ page.title }} </h5>

<div class="card">
{% for post in site.categories.jekyll %}
<li class="category-posts"><span>{{ post.date | date_to_string }}</span> &nbsp; <a href="{{ post.url }}">{{ post.title }}</a></li>
{% endfor %}
</div>
55 changes: 50 additions & 5 deletions install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ layout: page
permalink: /get-started/
---

## Getting Started - Deploying your blog using devlopr-jekyll
## Getting Started - How to use “devlopr-jekyll” theme

Steps to create your blog using devlopr-jekyll and Host using Github Pages :
## What's Jekyll ?

> **Step 1.** Fork the repo - [click here](https://github.com/sujaykundu777/devlopr-jekyll/fork)
If you aren’t familiar with Jekyll yet, you should know that it is a static site generator. It will transform your plain text into static websites and blogs. No more databases, slow loading websites, risk of being hacked…just your content. And not only that, with Jekyll you get free hosting with GitHub Pages! If you are a beginner we recommend you start with [Jekyll’s Docs](https://jekyllrb.com/docs/installation/). Now, if you know how to use Jekyll, let’s move on to using this theme in 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)
![Devlopr Jekyll Repo](/assets/img/posts/fork1.png){:class="img-fluid"}

Expand Down Expand Up @@ -45,7 +48,7 @@ Steps to create your blog using devlopr-jekyll and Host using Github Pages :

> **Step 5** - Install the development requirements:
Let's first set up our development environment, You might need to install the following tools:
### Set up local development environment

1. [Git](https://git-scm.com/)
2. [Ruby](https://www.ruby-lang.org/) and [Bundler](https://bundler.io/)
Expand All @@ -62,6 +65,7 @@ ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu]
For bundler :

```bash
$ gem install bundler
$ bundler -v
Bundler version 2.1.4
```
Expand Down Expand Up @@ -89,7 +93,7 @@ $ bundle install
> **Step 7.** Serve the site locally by running the following command below:
```bash
$ bundle exec jekyll serve
$ bundle exec jekyll serve --watch
```
or you can also serve using :

Expand All @@ -103,6 +107,47 @@ Visit [http://localhost:4000](http://localhost:4000) for development server

![Devlopr Jekyll Repo](/assets/img/posts/fork41.png){:class="img-fluid"}

### Adding Content

Start populating your blog by adding your .md files in _posts. devlopr-jekyll already has a few examples.

#### YAML Post Example:

```yml
---
layout: post
title: Sample Post
author: Sujay Kundu
date: '2019-05-21 14:35:23 +0530'
category:
- jekyll
summary: This is the summary for the sample post
thumbnail: sample.png
---

Hi ! This is sample post.

```

#### YAML Page Example:

```yml
---
layout: page
title: Sample Page
menus: header
permalink: /sample-page/
---

Hi ! This is sample page.
```

#### Editing stylesheet

You’ll only work with a single file to edit/add theme style: assets/css/main.scss.

### Deploy your Changes

Once happy with your blog changes. Push your changes to master branch.

> **Step 8.** Push Your Local Changes
Expand Down

0 comments on commit 1a86659

Please sign in to comment.