emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Sébastien Gendre" <seb@k-7.ch>
To: General discussions about Org-mode <emacs-orgmode@gnu.org>
Subject: Enhancing the HTML exporter: Create a new backend or contribute to the upstream
Date: Wed, 28 Aug 2024 03:29:14 +0200	[thread overview]
Message-ID: <87h6b51llh.fsf@k-7.ch> (raw)

[-- Attachment #1: Type: text/plain, Size: 2038 bytes --]


TL;DR: Plan to add features to HTML export, do I add them in the
       built-in HTML exporter (as upstream contribution) ? Or as a
       downloadable derived backend ? Which on do you prefer ?


Hello,

I plan to use Org-publish to create a website from Org-mode files. And I
would have some features that are not provided by the built-in HTML
exporter.

To add theses features, my first plan was to customize an org-publish
project. Using a custom preamble function, a custom completion function
and some new export options added to "org-export-options-alist".

It's still a work in progress, but the more feature I add, the more I
think I need to add them in an export backend.

So, my second plan is to create an export backend, derived from the
built-in HTML exporter.

But maybe you would prefer that I add these new features as a
contribution to the built-in HTML exporter ?

Here is what I plan to add, on each generated webpage, compared to what
the built-in HTML exporter already provide:

- A side panel containing:
  - A site web name and/or logo
  - A search field for an local search engine
  - A main navigation menu, built from a dedicated org-mode file
- A more "modern" look
- More special blocks available like:
  - A question/answer bloc, where the answer is hidden
  - Important, warning and tip blocks
  - A generic hide-show bloc
- Tab to select which content to see
- Bibliography on a dedicated webpage when using org-publish
- A button to download the Org-mode file source of a webpage
- Possibility to set the home page, when there is no index.org
  
As say above, I started it as a custom org-publish
project. You can found my work in progress here:
https://framagit.org/SebGen/org-documentation-template

For now, the search engine use the software Pagefind:
https://pagefind.app

And the menu is made from an org-mode file where first level heading
become menu item and links are simple org-mode links.


Best regards

-------
Gendre Sébastien

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 849 bytes --]

             reply	other threads:[~2024-08-28  1:30 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-28  1:29 Sébastien Gendre [this message]
2024-08-28  1:52 ` Enhancing the HTML exporter: Create a new backend or contribute to the upstream Sébastien Gendre
2024-09-01 15:58 ` Ihor Radchenko
2024-09-02  5:09   ` Sébastien Gendre
2024-09-07 11:53     ` Ihor Radchenko
2024-09-08 14:46       ` Max Nikulin
2024-09-08 15:55         ` Max Nikulin
2024-09-08 18:36           ` Orm Finnendahl
2024-09-08 18:42             ` Ihor Radchenko
2024-09-08 19:25               ` Orm Finnendahl
2024-09-09 16:40                 ` Ihor Radchenko
2024-10-23  5:40                   ` Sébastien Gendre
2024-10-23  5:40                 ` Sébastien Gendre
2024-10-23  5:39               ` Sébastien Gendre
2024-10-23  5:39             ` Sébastien Gendre
2024-10-23  5:34           ` Sébastien Gendre
2024-10-23  5:32       ` Sébastien Gendre

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87h6b51llh.fsf@k-7.ch \
    --to=seb@k-7.ch \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).