Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.95 KB

README.md

File metadata and controls

80 lines (51 loc) · 1.95 KB
Raw

SublimeConfluence

Sublime Text 3 plugin for integrate with Atlassian Confluence

Installation

Use sublime package manager

  • you should use sublime package manager
  • use cmd+shift+p then Package Control: Install Package
  • look for Confluence and install it.

Manually

At the moment Git is required to install the plugin. You will need to clone the repository in your Sublime Text "Packages" directory:

git clone [email protected]:mlf4aiur/SublimeConfluence.git "Confluence"

The "Packages" directory is located at:

  • OS X: ~/Library/Application Support/Sublime Text */Packages/
  • Linux: ~/.Sublime Text */Packages/
  • Windows: %APPDATA%/Sublime Text */Packages/

Settings

Add the following to your User Settings file:

{
    "base_uri": "https://confluence.example.com/confluence/rest/api",
    "default_space_key": "ENG",
    "username": "username",
    "password": "password"
}

If the password unset, then you need to input the password every time, and don't edit the password inline this plugin can not handle it properly.

Usage

Demo:

demo

Post page to Confluence

Supported markup languages:

META data must be given, and put it on the head of document, use newline to separate META data and content.

Example files: example.md, example.rst.

META data:

  • Space
  • Ancestor Title
  • Title

Use Command Palette to run it, use cmd+shift+p then Post page to Confluence to post local page to remote.

BTW

Confluence supports buildin markup(Textile like) and markdown syntax insert. On the Confluence edit mode, press command + shift + D, to insert markup text.

License

SublimeConfluence is BSD Licensed.