emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* org-roam to HTML: My needs are unusual?
@ 2022-03-11 12:03 c.buhtz
  2022-03-11 15:03 ` Kaushal Modi
  2022-03-11 15:33 ` Max Nikulin
  0 siblings, 2 replies; 3+ messages in thread
From: c.buhtz @ 2022-03-11 12:03 UTC (permalink / raw)
  To: emacs-orgmode

Hello together,

this post is not about a technical problem but I need your advice and 
opinion as experienced org(roam) users and developers. I am a bit 
frustrated.

Some of you have noticed that I tried to generate HTML files out of my 
org-roam notes. In the current state I am failed. On one side because of 
technical problems/bugs and on the other side because of tools not 
fitting my needs.

At the end I would subscribe my need like that:
I want all my org-roam-v2 notes (means org file with ID-links) 
transformed to HTML-files which I can use via file:// protocol (means 
without a server).

Sounds simple to me but the reality looks different. And I wonder if my 
use case is not so usual as I thought. Am I the only person experience 
that problems?

I tried ox-publish but there are problems (and known bugs [1]) with 
creating correct links/urls between the HTML-files based on the 
org-roam-v2-ID-links. I do not understand the technical details and I am 
not able to surly reproduce the problems. But I heard from many sides 
that I am not the only person with that problem.

ox-hugo with hugo is often mentioned in the context. But ox-hugo is not 
able to export everything out-of-the-box [2]. And the HTML files 
generated by hugo are not usable via the file:// protocol without some 
hacks [3].

My wish would be that the ox-publish would work. I prefer in-build 
things. But I am not sure how the result would look like if it work.

Currently I think about creating a Python tool parsing the org files by 
itself and doing all the needed stuff. But I do not want to waste my 
time here when the ox-publish problem is solved in the next months.

Thanks in advance
Christian

[1] -- <https://list.orgmode.org/87v9kavoms.fsf@gnu.org/>
[2] -- <https://github.com/kaushalmodi/ox-hugo/discussions/585>
[3] -- <https://discourse.gohugo.io/t/where-are-the-html-files>


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

* Re: org-roam to HTML: My needs are unusual?
  2022-03-11 12:03 org-roam to HTML: My needs are unusual? c.buhtz
@ 2022-03-11 15:03 ` Kaushal Modi
  2022-03-11 15:33 ` Max Nikulin
  1 sibling, 0 replies; 3+ messages in thread
From: Kaushal Modi @ 2022-03-11 15:03 UTC (permalink / raw)
  To: emacs-org list

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

Hello Christian,

tl;dr: If you decide to learn how to use Hugo (read its docs, ask questions
on its forum, etc.), this[1] should solve the issues you have faced so far.

---

Details:

On Fri, Mar 11, 2022 at 7:04 AM <c.buhtz@posteo.jp> wrote:

>
> ox-hugo with hugo is often mentioned in the context. But ox-hugo is not
> able to export everything out-of-the-box [2].
> [2] -- <https://github.com/kaushalmodi/ox-hugo/discussions/585>


Correct, because it is not the job of `ox-hugo` to figure out how the user
needs to export all the Org files. I see users coming with various
use-cases; it is out of scope of my free time to attempt to support all of
that in the ox-hugo package:

- How to export only the Org files that already have the Markdown exported?
- How to export Org files written for <xyz> package?
- This didn't work on Windows.
- etc.

So I encourage the users to attempt to learn a bit of elisp or Makefile or
bash to do this batch exporting for them. I have posted one solution to
this here[4], but I won't be surprised if this solution is not exactly what
someone wants (for example, that solution does not update the org-id
locations from everywhere a user has their Org files).


And the HTML files
> generated by hugo are not usable via the file:// protocol without some
> hacks [3].
> [3] -- <https://discourse.gohugo.io/t/where-are-the-html-files>
>

Those are not hacks; those are Hugo switches a user can use to generate the
kind of HTML they need (with or without ugly URLs, with or without relative
URLs, with or without RSS, so on and so forth).

[1]:
https://github.com/kaushalmodi/ox-hugo/discussions/585#discussioncomment-2339756
[4]:
https://github.com/kaushalmodi/ox-hugo/discussions/585#discussioncomment-2335203

[-- Attachment #2: Type: text/html, Size: 3082 bytes --]

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

* Re: org-roam to HTML: My needs are unusual?
  2022-03-11 12:03 org-roam to HTML: My needs are unusual? c.buhtz
  2022-03-11 15:03 ` Kaushal Modi
@ 2022-03-11 15:33 ` Max Nikulin
  1 sibling, 0 replies; 3+ messages in thread
From: Max Nikulin @ 2022-03-11 15:33 UTC (permalink / raw)
  To: emacs-orgmode

On 11/03/2022 19:03, c.buhtz@posteo.jp wrote:
> 
> At the end I would subscribe my need like that:
> I want all my org-roam-v2 notes (means org file with ID-links) 
> transformed to HTML-files which I can use via file:// protocol (means 
> without a server).

Christian, you may confuse people requiring file: protocol. I think, for 
hugo or for other approaches to export, the goal is to get *relative* 
links <a href="dir/another.html#something">something</a>. In such case 
any file may be opened in a browser and links (images, CSS styles) will 
work.

In some cases it is still easier to run a HTTP server bound to loopback 
network interface:
    python3 -m http.server 8080 --bind 127.0.0.1 --directory 
/path/to/your/files

I would suggest to not mix general questions related to org-export and 
org-publish with ones specific to org-roam such as backlinks. The latter 
should be addressed to the developers of org-roam.



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

end of thread, other threads:[~2022-03-11 15:37 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-03-11 12:03 org-roam to HTML: My needs are unusual? c.buhtz
2022-03-11 15:03 ` Kaushal Modi
2022-03-11 15:33 ` Max Nikulin

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