Giter Club home page Giter Club logo

dev-blog's Introduction

  _          _           _     _  __ _
 | |__   ___| |_ __  ___| |__ (_)/ _| |_
 | '_ \ / _ \ | '_ \/ __| '_ \| | |_| __|
 | | | |  __/ | |_) \__ \ | | | |  _| |_
 |_| |_|\___|_| .__/|___/_| |_|_|_|  \__|
   __| | _____|_|__    | |__ | | ___   __ _
  / _` |/ _ \ \ / /____| '_ \| |/ _ \ / _` |
 | (_| |  __/\ V /_____| |_) | | (_) | (_| |
  \__,_|\___| \_/      |_.__/|_|\___/ \__, |
                                      |___/

Adding a new post

Create a new file inside _posts named in this format: YYYY-MM-DD-my-new-post.md.

Inside the file, you need to add a preamble that looks like this:

---
layout: post
title: My New Post
tags: tag1 tag2
author:
    name: John Doe
    email: [email protected]
    meta: President of Vice
---

After the preamble you can write the post in Markdown.

Setup & running

To build the blog and get a live preview you need to install Jekyll and Grunt.

Jekyll setup

  1. Get Bundler - gem install bundler
  2. Get Jekyll and dependencies - do a bundle install inside the project directory.
  3. Run jekyll build

Grunt setup

To setup live preivew, you need to install npm. After installing npm you can just do a npm install inside the project directory.

Once npm has installed all dependencies you can call grunt inside the project directory.

Grunt will then automatically compile any changes to the blog posts and serve them via an internal webserver at the url http://localhost:4000/

Contributing

Bug fixes, etc are welcome. If you would like to write an article on our blog send us a pull-request and we'll consider it.

License

Copyright 2017, Helpshift, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

#Authors

  • Abhishek Mishra @ideamonk
  • Baishampayan Ghose @ghoseb

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.