https://github.com/mrkrd/tributary
Edit Confluence wiki pages in Emacs.
https://github.com/mrkrd/tributary
confluence emacs major-mode rest-api wiki xml
Last synced: 29 days ago
JSON representation
Edit Confluence wiki pages in Emacs.
- Host: GitHub
- URL: https://github.com/mrkrd/tributary
- Owner: mrkrd
- License: gpl-3.0
- Created: 2021-12-29T20:15:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-03T16:30:22.000Z (over 3 years ago)
- Last Synced: 2025-03-29T11:41:40.986Z (about 2 months ago)
- Topics: confluence, emacs, major-mode, rest-api, wiki, xml
- Language: Emacs Lisp
- Homepage:
- Size: 26.4 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- License: COPYING.txt
Awesome Lists containing this project
README
* 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.,
#+begin_src elisp
(setq tributary-api-url "https://example.com/wiki/rest/api/content/")
#+end_src
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 [[https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html][Confluence Storage Format]].
- =M-x tributary-pretty-print-buffer= will re-format the buffer,
but requires [[http://www.html-tidy.org/][tidy]].
5. Push by typing =C-c C-c=.
** References
- https://sourceforge.net/projects/confluence-el/
- https://github.com/aspiers/orgmode/blob/master/contrib/lisp/ox-confluence.el
- https://teddit.net/r/emacs/comments/7pytxd/how_to_deal_with_confluence/
** License
The project is licensed under the GNU General Public License v3 or
later (GPLv3+).