emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: "Sébastien Gendre" <seb@k-7.ch>
Cc: General discussions about Org-mode <emacs-orgmode@gnu.org>
Subject: Re: Examples of online documentation written with Org-mode
Date: Sat, 10 Aug 2024 17:13:15 +0000	[thread overview]
Message-ID: <87ed6w713o.fsf@localhost> (raw)
In-Reply-To: <87wmkoyfxh.fsf@k-7.ch>

Sébastien Gendre <seb@k-7.ch> writes:

> I start to explore Org-mode and org-publish to built online
> documentation.
>
> And I search for example of online documentation made with Org-mode. As
> inspirations.
>
> But after some search, I have only found the Org-mode Worg [1]. Other
> found are no more online.

One orthodox approach is exporting to .texi -> .html. It is how
https://orgmode.org/manual/ and
https://elpa.gnu.org/packages/doc/modus-themes.html are generated.

Another common approach is writing elaborate README.org in
repositories. There are many examples on GitHub, like
https://github.com/alphapapa/org-ql/

Many blogs are also made with Org mode. Not sure if it qualifies for
documentation.

You may also take a look at https://github.com/fniessen/org-html-themes
(ReadTheOrg), https://orgmode.org/tools.html, and https://orgmode.org/worg/org-blog-wiki.html

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


  parent reply	other threads:[~2024-08-10 17:12 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-10  7:50 Examples of online documentation written with Org-mode Sébastien Gendre
2024-08-10 12:41 ` Samuel Loury
2024-08-10 17:01   ` Sébastien Gendre
2024-08-10 17:13 ` Ihor Radchenko [this message]
2024-08-10 19:48   ` András Simonyi
2024-08-11  5:17   ` mbork
2024-08-11  6:19     ` Ihor Radchenko
2024-08-11  7:59       ` Phil
2024-08-11 16:39         ` Ihor Radchenko
2024-08-12 10:18           ` Phil Estival
2024-08-18 12:26             ` Ihor Radchenko
2024-08-11 17:21         ` Thomas Redelberger
2024-08-11  7:45 ` Juergen Fenn
2024-08-11 18:30 ` Steve Downey
  -- strict thread matches above, loose matches on Subject: below --
2024-08-11  2:41 Sébastien Gendre
2024-08-11  2:44 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=87ed6w713o.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=seb@k-7.ch \
    /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).