emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Examples of online documentation written with Org-mode


From: Ihor Radchenko
Subject: Re: Examples of online documentation written with Org-mode
Date: Sun, 11 Aug 2024 16:39:47 +0000

Phil <pe@7d.nz> writes:

>> Note that it is listed in https://orgmode.org/tools.html since long ago ;)
>> 
>
> Mine too (https://gitlab.com/7dnz/org-weblog) lands in this
> category, with an emphasize on a — very verbose I admit — but strict
> literate programming. It's a 99KB file, with tests, attempts,
> explanations, explorations, etc.
> The page documentation is produced as blog post by evaluating
> directly from the code and documentation being redacted.
>
> It doesn't use the tangle processor but evaluates one section
> after the other. This is how I learned Lisp. It may stay as a
> beginner's work forever but I don't mind, it works, and I like it.
>
> Here are the functions it lacks to make it a complete blogging engine :
> search, archival by year/month, previous/next post, pagination, one 
> folder by post, and a few custom properties :
> the author of a post and a custom stylesheet per post among others.

While reading it, I did not immediately figure out what that thing is
for and how to use it. There is even no license.

I recommend going through the process of publishing package via
ELPA/non-GNU ELPA. It will give you a chance to improve the code, docs,
and polish the package in general.

For now, it looks more like a personal config file; not like a project
to be used by others.

https://one.tonyaldon.com/docs/getting-started/ (one.el) project appears
to have a similar spirit. You may get an inspiration from there.

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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]