Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 1.36 KB

README.org

File metadata and controls

51 lines (29 loc) · 1.36 KB

tributary.el

GNU Emacs major mode to edit Atlassian Confluence wiki pages.

tributary.el can pull a wiki page via Confluence REST API, edit it in as XML file, and update remote page.

WARNING: This software is in alpha quality! I decided to release it anyways as an MVP.

How to Use

  1. Set tributary-api-url, e.g.,
    (setq tributary-api-url "https://example.com/wiki/rest/api/content/")
        
  2. Configure authentication.
    • Create an API token for your Confluence account.
    • Make this token available to auth-source.el (this is what request.el / tributary.el use for authentication).
  3. Pull a page.
    • M-x tributary-pull-id & input numerical ID of the page.
    • M-x tributary-pull-url & input ULR of the page.
  4. Edit your page in Confluence Storage Format.
    • M-x tributary-pretty-print-buffer will re-format the buffer, but requires tidy.
  5. Push by typing C-c C-c.

References

License

The project is licensed under the GNU General Public License v3 or later (GPLv3+).