https://github.com/janis-kra/split-guide-atom

An Atom plugin that simplifies creating workshops using @kentcdodds split-guide
https://github.com/janis-kra/split-guide-atom

atom-plugin split-guide workshop

Last synced: 11 months ago
JSON representation

An Atom plugin that simplifies creating workshops using @kentcdodds split-guide

• Host: GitHub
• URL: https://github.com/janis-kra/split-guide-atom
• Owner: janis-kra
• License: mit
• Created: 2017-01-25T07:59:34.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-26T21:09:08.000Z (about 9 years ago)
• Last Synced: 2025-01-14T19:11:40.669Z (about 1 year ago)
• Topics: atom-plugin, split-guide, workshop
• Language: JavaScript
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# split-guide-atom package

An Atom plugin that simplifies creating workshops using @kentcdodds awesome [split-guide](https://github.com/kentcdodds/split-guide) 

![Demo GIF](https://s27.postimg.org/na88jzikj/split_guide_atom_demo.gif)

## Why?

When creating a workshop using the aforementioned [split-guide](https://github.com/kentcdodds/split-guide) tool, I often had typos in the `// WORKSHOP` and/or `// FINAL` comments that you have to do when creating your workshop templates.

Also, I type `// WORKSPACE` instead of `// WORKSHOP` all the time...

This small Atom plugin fixes that problem by typing the comments for you when you click the corresponding menu item.

## Installation

Install it inside Atom via Settings -> Install -> Search for 'split-guide-atom' and click 'Install'. Or just `apm install split-guide-atom`

## Usage

First, select the portion of your source code that should be wrapped in `WORKSHOP`, `FINAL` or `COMMENT` comments. Or just place the cursor at any position inside the editor.

You then have three ways of issuing the commands (example for `WORKSHOP` comments):

* Via menu: Packages -> Split Guide -> Wrap in WORKSHOP comments

* Via shortcut: Cmd+Shift+P / Ctrl+Shift+P and then type `WORKSHOP` (the command should then read 'Split Guide Atom: Workshop') -> Enter

* Via context menu: Right click in the editor -> Click 'Wrap in WORKSHOP comments'