Git Product home page Git Product logo

jekyll-post's Introduction

Visual Studio Code Extension for Creating Jekyll Posts

This extension makes it easier to create new blog posts for Jekyll-based websites using the Visual Studio Code editor.

Using this extension, a user can create new post file with pre-filled "front matter". The template for front matter can either be provided by the user or the extension will use its built-in template.

Usage instructions

If a user wants to provide a template file for new posts, they should create a file: .post-template in the Jekyll project root directory.

Here's an example of the template file:

$ cat $PROJECT_ROOT/.post-template
---
layout: post
title: This is a new article
author: User
summary: Summary of the article
---

If no template is provided, the extension will use its built-in template for new posts. The default template is as follows:

---
layout: post,
title: This is a new article
date: YYYY-MM-DD HH:MM
category: Category
author: User
tags: [tag1, tag2]
summary: Summary of the article
---

To create a new post, a user must right click on a directory in the explorer menu and select the "New Post" option. Then, a dialog box prompts the user to provide the name of the file.

Features

  • Adds a new explorer context menu option to create new blog posts
  • Sets up the file name automatically in the format expected by Jekyll (YYY-mm-dd-*.*)
  • Ability to provide a template file for new posts in the Jekyll project root directory
  • If no template file is provided, the extension uses a pre-defined template for new posts. The Tab key can be used to move between and edit the different attributes/fields in the front matter.

Requirements

This has only been tested on the latest release (v.1.34.0) of Visual Studio Code. It may or may not work on earlier releases.

Extension Settings

There are no extension-specific settings for now.

Todo

  • Location and name of post template file should be configurable
  • Tab-based navigation with user-provided post template

jekyll-post's People

Contributors

fiyafly avatar rohgarg avatar

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.