Viblo Atom Plugin package

Viblo Plugin for Atom editor. Vietnamese documentation is available here.

Requirement

• Atom version 1.x

Installation

• Open Atom
• Go the Packages > Settings View > Open or press Ctrl + Shift + P (Linux/Windows) or Cmd + Shift + P (macOS), in the search menu type the keywords Install packages and click Settings View:Install Packages and Themes.
• In the search bar type viblo and then install it 😄

Features

• Get Posts and Drafts list from Viblo
• Create a new post and save it as a draft or publish it
• Edit an existed draft or post
• Upload images to Viblo
• Markdown preview with Viblo's supported syntaxes

Usage

Setting

• Go to Viblo Setting Page to create an API key
• Press Ctrl + Shift + P (Linux/Windows) or Cmd + Shift + P (macOS), type viblo, then go to Viblo: Settings page. Paste your API key here then reload your Atom.
• Go to:
  • Viblo: Publish Posts page to check your published posts.
  • Viblo: Draft Posts page to check your drafts.
  • Viblo: Gallery page to manage your images.

Create new posts

• Press Ctrl + Shift + P or Cmd + Shift + P (macOS), type viblo then go to Viblo: Create Post. Viblo editor will be open for you. Let's fill your post contents here.
• Right click at Atom, then choose Viblo Toggle Preview to review your post contents.
• Right click at Atom, then choose Save to Viblo to open Publish Form where you can fill title, tags, category and language. After that, click Publish post button or Save as Draft button to save this post into Viblo.
• And on the other way, you can create (or open) markdown file (with .md as file extension). Then right click at Atom, choose Save to Viblo to save post into Viblo.

Edit a post or draft

• Go to Viblo: Publish Posts or Viblo: Draft Posts page to check your posts.
• Click on the post title that you want to edit. The Viblo editor will be open.
• Right click at Atom, then choose Viblo Toggle Preview to review your post contents.
• Right click at Atom, then choose Save to Viblo to open Publish Form where you can fill title, tags, category and language. After that, click Publish post button or Save as Draft button to save post into Viblo.

Key maps

If you are using macOS, use Cmd instead Ctrl. Atom key maps that you should know before using:

• Ctrl + Shift + P: Find and run available commands in atom.
• Ctrl + S: Save your contents to local file from atom editor.
• Ctrl + Shift + F5: Restart/Reload Atom.

Viblo Atom Plugin key maps are supported:

• Ctrl + Alt + O or Ctrl + Alt P: Open Publish Posts page - List of all published posts.
• Ctrl + Alt + D: Open Draft Posts page - List of all (public) drafts.
• Ctrl + Alt + G: Open Gallery page.
• Ctrl + Alt + S: Open Settings page - Where you can login or logout by Viblo Api token.
• Ctrl + Alt + A: Open About page - Information about Viblo Atom Plugin.
• Ctrl + Alt + C: Create new post.
• Ctrl + Shift + S: Toggle Publish Form to save content from atom editor into Viblo.
• Ctrl + Alt + V: Toggle Viblo Preview to review your content from atom editor before publish.
• Ctrl + Alt + I: Toggle Image Helper from atom editor to upload your image, insert image into your contents.

Developing

1. Clone repository

cd ~/ & git clone git@github.com:viblo-asia/atom-plugin.git

to ~/.atom/packages folder or make symlink inside this folder named viblo

ln -s ~/atom-plugin ~/.atom/packages/viblo

2. Press Ctrl + Shift + P, type the command Window: reload or just reload and press Enter to reload Atom workspace and after that viblo will be available in list of installed packages.
3. Check that our package has been installed, press Ctrl + Shift + P, type the command Settings View: View Installed Packages or just Installed Packages (command line have fuzzy autocomplete) and press Enter.

Note: To check your code need to reload Atom workspace each time

Helpful links

• Documentation of Atom
• Atom API
• Specification of Versioning of package

Licence

MIT