https://github.com/dickmao/nndiscourse

A Gnus backend for Discourse
https://github.com/dickmao/nndiscourse

Last synced: about 4 hours ago
JSON representation

A Gnus backend for Discourse

• Host: GitHub
• URL: https://github.com/dickmao/nndiscourse
• Owner: dickmao
• License: gpl-3.0
• Created: 2019-08-28T18:23:08.000Z (about 5 years ago)
• Default Branch: gitawonk
• Last Pushed: 2023-07-05T12:31:42.000Z (about 1 year ago)
• Last Synced: 2023-12-01T22:35:31.514Z (10 months ago)
• Language: Emacs Lisp
• Size: 102 KB
• Stars: 21
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.in.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
|build-status| |melpa-dev|

.. COMMENTARY (see Makefile)

.. |build-status|

   image:: https://github.com/dickmao/nndiscourse/workflows/CI/badge.svg?branch=dev

   :target: https://github.com/dickmao/nndiscourse/actions

   :alt: Build Status

.. |melpa-dev|

   image:: https://melpa.org/packages/nndiscourse-badge.svg

   :target: http://melpa.org/#/nndiscourse

   :alt: MELPA current version

.. image:: https://github.com/dickmao/gnus-imap-walkthrough/blob/master/thumbnail.png

   :target: https://youtu.be/DMpZtC98F_M

   :alt: Replacing Thunderbird With Gnus

.. image:: screenshot.png

.. |--| unicode:: U+2013   .. en dash

.. |---| unicode:: U+2014  .. em dash, trimming surrounding whitespace

   :trim:

We Moved To Gitawonk

====================

https://gitawonk.com/dickmao/nndiscourse.git

Git paid, not played.

Does not work for sites requiring login

=======================================

Some discourse instances allow unfettered public viewing, e.g.,

``emacs-china.org``, ``devforum.roblox.com``.  Others require login, e.g.,

``discourse.doomemacs.org``.  At the time I wrote nndiscourse, it was

impossible to get login going, and while `it does seem possible now

`_,

it still looks really hard and undocumented.

Install

=======

As described in `Getting started`_, ensure melpa's whereabouts in ``init.el`` or ``.emacs``::

   (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/"))

Then

::

   M-x package-refresh-contents RET

   M-x package-install RET nndiscourse RET

You will also need Bundler_ for Ruby.

Alternatively, directly clone this repo and ``make install``.

Also see Troubleshooting_.

Usage

=====

Suppose you want to follow https://emacs-china.org.  In your ``.emacs`` or ``init.el``, use ONE of the following:

::

   ;; Applies to first-time Gnus users

   (custom-set-variables '(gnus-select-method

       (quote (nndiscourse "emacs-china.org" (nndiscourse-scheme "https")))))

or, if you're an existing Gnus user,

::

   ;; Applies to existing Gnus users

   (add-to-list 'gnus-secondary-select-methods

       (quote (nndiscourse "emacs-china.org" (nndiscourse-scheme "https"))))

Then ``M-x gnus``.

Select a topic category via ``RET``.  Rapidly catch yourself up via ``N`` and ``P``.  Instantly catch-up with ``c``.

From the ``*Group*`` buffer, press ``g`` to refresh all categories.  ``M-g`` on a particular category to refresh individually.

From the summary buffer, ``/o`` redisplays posts already read.  ``x`` undisplays them.

Gnus beginners may find the interface bewildering.  In particular, categories with no unread posts do not display.  Use ``L`` to bring them out of hiding.

Troubleshooting

===============

Clone this repo.  Then install Cask_.  Then try ``make test-run-interactive``.

.. _Cask: https://cask.readthedocs.io/en/latest/guide/installation.html

.. _Getting started: http://melpa.org/#/getting-started

.. _Bundler: https://bundler.io