How to export all Org files in a directory + How to generate offline navigable HTML files using Hugo?

[buhtz]

From the documentation it is a bit unclear for me how I can export all existing org files I have created with org-roam-v2.
I know about org-hugo-export-wim-to-md which export the current buffer only.

I want to export all org files without opening one in a buffer.

Maybe the term "subtree" has something to do with this? But I do not understand what this is.

My goal is not a blog or nice looking website. I simply want to read all my org-roam-v2 created nodes as HTML files.

[kaushalmodi]

Maybe the term "subtree" has something to do with this?

No, a "subtree" is an Org mode subtree. For example, see subtrees A and B below.

* A
Something
* B
Something

[buhtz]

I would call this a head or sub heading. Am I right?

[kaushalmodi]

• Just "A" is the heading.
• But everything A and under that is a "subtree".

The "subtree" term is used consistently in Org manual. See the (org) Headlines Info node.

It is also the "subtree" that you export when you use the default C-c C-e C-s .. binding in Org to export using any exporter:

[kaushalmodi]

My goal is not a blog or nice looking website.

Yeah, that's unrelated to ox-hugo. The "looks" of your site depend solely on your Hugo layout files or the theme.

[kaushalmodi]

I want to export all org files without opening one in a buffer.

This is out of the scope of ox-hugo. Typically you would call emacs in batch mode, loop through all the Org files you want to export and call the "wim" export function on each.

Here's one example of how to export all files from the command line (Credit: @shombando).

[kaushalmodi]

Well, hugo is a static site generator. You'll just need to learn that tool and certain concepts on how HTML pages work. You are probably generating pages with absolute URLs instead of relative URLs. Hugo can generate both kind, but then you need to pick a theme that ensures that the pages can be viewed offline (i.e. uses relative permalinks).

I would suggest you asking a question on Hugo forum (there are a lot of helpful and friendly folks there. They helped me as I was researching on Hugo and developing ox-hugo. I had no idea about relative and absolute URLs when I started as well): https://discourse.gohugo.io/. Ask if people are aware of Hugo themes that can generate offline HTML content; that you want to generate pages for offline viewing and don't plan to host them on any server.

A browser can not handle this because no server is running serving him a index.html

I don't see why an index.html cannot be viewed offline. The only difference that a page being foo/index.html makes vs foo.html is that the former can be viewed on file://foo/ url while the latter can be viewed on file://foo.html. In Hugo lingo, the urls with ".html" are called "ugly" urls (you can look up uglyURLs in Hugo docs) and the urls ending in "/" are "pretty" URLs. Look up on how to make Hugo generate pages with ugly urls.

I am afraid I have to do all this on my own with a Python script beginning from parsing the org-roam-files. This would give me more control and power over the process.

Certainly! If you go that route, eventually you will understand why those links in public/ did not work because you'll need to learn HTML :)

Maybe my use case is to unusual?

No, Hugo deploys its documentation site releases .tar.gz files such that they are viewable offline too.

[buhtz]

Thanks for your thoughts and ideas.

[kaushalmodi]

@Codeberg-AsGithubAlternative-buhtz I believe my reply should provide you a minimal example of how to design the Hugo config and layout files to make your generated HTML pages locally navigable.

Note: There's a difference between static and offline HTML pages. A static site generator generates HTML pages that are self-contained and don't require to dynamically fetch page content from external databases (like Wordpress and others do).

[buhtz]

(defun ox-hugo/export-all (&optional org-files-root-dir dont-recurse)
  "Export all Org files (including nested) under ORG-FILES-ROOT-DIR.
...

There is one little problem with that function. All opened buffers with the org files are kept open. Can this code be modified that way that the buffer is closed after its content is exported to md?

[kaushalmodi]

All opened buffers with the org files are kept open.

That's what I meant earlier that it's not possible to support this officially.

You'll need to first check if a buffer is already open before it's exported and then close that buffer only if it wasn't open before the export.

I'll encourage to read up on the buffer management functions from emacs lisp Info manual, ask questions on emacs sub reddit or emacs gnu help and learn more.

This function is best used if you call it from an emacs session in batch mode, through a shell script or Makefile. Then you don't have to worry about open files.

[kaushalmodi]

@Codeberg-AsGithubAlternative-buhtz I am summarizing the solutions to your questions here (for future, please open separate Discussion topics for each question).

• How to export all Org posts in a directory to Markdown using ox-hugo?
• How to use Hugo so that it generates HTML pages that can be navigated without a server?

[buhtz]

Please allow me to warm up the topic. As stated in this comment two years ago I now released my own org-to-html-converter.

[bphenriques]

Don't know if already shared here. In my now archived digital garden I setup a automated GHA to publish my org-files, it should be portable: https://github.com/bphenriques/knowledge-base/blob/master/.github/workflows/build-deploy.yml