emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Examples of online documentation written with Org-mode
@ 2024-08-10  7:50 Sébastien Gendre
  2024-08-10 12:41 ` Samuel Loury
                   ` (3 more replies)
  0 siblings, 4 replies; 16+ messages in thread
From: Sébastien Gendre @ 2024-08-10  7:50 UTC (permalink / raw)
  To: General discussions about Org-mode

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

Hello,

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.


Best regards

-------
Gendre Sébastien


[1] https://orgmode.org/worg/

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

^ permalink raw reply	[flat|nested] 16+ messages in thread
* Re: Examples of online documentation written with Org-mode
@ 2024-08-11  2:41 Sébastien Gendre
  0 siblings, 0 replies; 16+ messages in thread
From: Sébastien Gendre @ 2024-08-11  2:41 UTC (permalink / raw)
  To: Ihor Radchenko

[[PGP Signed Part:Good signature from B586F7C77239E29E Sébastien Gendre <seb@k-7.ch> (trust ultimate) created at 2024-08-11T04:41:57+0200 using RSA]]
[1. text/plain]
Thank you very much.

I will take a look.


Ihor Radchenko <yantar92@posteo.net> writes:

> 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

[[End of PGP Signed Part]]


^ permalink raw reply	[flat|nested] 16+ messages in thread
* Re: Examples of online documentation written with Org-mode
@ 2024-08-11  2:44 Sébastien Gendre
  0 siblings, 0 replies; 16+ messages in thread
From: Sébastien Gendre @ 2024-08-11  2:44 UTC (permalink / raw)
  To: András Simonyi

[[PGP Signed Part:Good signature from B586F7C77239E29E Sébastien Gendre <seb@k-7.ch> (trust ultimate) created at 2024-08-11T04:44:32+0200 using RSA]]
[1. text/plain]
It's a very good example.

Is it more common to make a single file documentation ?

András Simonyi <andras.simonyi@gmail.com> writes:

> Dear All,
>
>> Sébastien Gendre <seb@k-7.ch> writes:
>> > And I search for example of online documentation made with Org-mode. As
>> > inspirations.
>
> AFAIU, the online documentation of the Magit and Borg Emacs packages
> by Jonas Bernoulli were also made using Org (probably with the texinfo
> exporter), see https://magit.vc/manual/magit.html and
> https://emacsmirror.net/manual/borg/ -- their sources can be found at
> https://github.com/magit/magit/blob/main/docs/magit.org and
> https://raw.githubusercontent.com/emacscollective/borg/main/docs/borg.org.
>
> best wishes,
> András

[[End of PGP Signed Part]]


^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2024-08-18 12:26 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
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

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).