Bastien Guerry <[email protected]> writes:

>> 1. What does the CLI do?
>
> The index.html file at https://bzg.fr/org-faq/index.html is generated in
> two steps. In a directory with org-faq.org (like the worg/ directory),
> you can run
>
> ~$ org-parse -r html org-faq.org > org-faq.json
> ~$ topics org-faq.json
>
> org-parse is a parser that takes an org file as input, parses it, output
> it as json. Here we use the "-r html" which renders the contents of the
> sections as HTML within the json file.
>
> topics is a script that takes a json file and exports it as a small html
> page. The json file is expected to contain "topics" (here FAQ entries).
>
> So the cron job would run both scripts (or more likely a shell script
> calling them both) every day to generate the standalone index.html file.
>
> I acknowledge that this adds some complexity: I commit to maintaining
> the cron job and the scripts, which should not be a burden for anyone
> other than me.

It is possible to generate from that an info manual or to add the FAQ as
of the org info manual? That would avoid the need open the browser and
make it easier to view inside Emacs.

Reply via email to