I exported a notebook to markdown (which is great), but I found that the files don't have links to other files like they were in Siyuan.
So, is there anyway to make markdown exports have links to other files?
Is it possible for markdown export to link to other files?
This post was last updated for 569 days ago, and the information may already be changed
1 Reference
Related articles
-
Siysuy •
The
anchor hashfeature currently creates a span object<span id="20231110120736-ze6m41f"></span>. Some kind of program should be able to understand and find this block inside the note as reference. Can anyone help me understand how this can be useful after export, where do I use this, which program understands this syntax?The export mode
Anchor hashfor notebook Markdown exporting has some limitations.In the case i want to publish a particular note (with links to other notes) my approach is:
- From main notebook export the notebook you want to publish to .sy.zip file
- Create new (temporary) notebook
- import .sy.zip file to new temp notebook
- Export temp notebook export it to any selectable format (only markdown is currently selectable)
Other limitation of
Anchor hasexport and the only way I got it to work (performed testing by exporting to Obsidian):- currently only works for notebook and does not allow nested notes. In the process of exporting all notes must be unnested inside notebook for .md export to function.
- Currently does not support block reference. Can only link to main note. Tested by importing to obsidian (not a siyuan issue, but a markdown syntax limitation i presume)
Depending on the responses here I might add a feature request soon that involves the concept of user selectable export syntax. In which before execution of export using
anchor hasha user can type in the conversion syntax to apply. User is presented with input fields much like thesettings > Export > Anchor text wrapping symbolfields.Conversion syntax for siyuan > obsidian would be: [[test3.md/Note 2#^d8bf62|Note 2]] and conversion input fields could somehow be [[ .. / .. #^ .. | .. ]]
1 Reply - MiscReply
-
sagar • • 2VIP Warrior
I think there is a fairly simple solution to this, which I will describe below. I think it can be implemented as a simple Python script that does some post-processing of the exported markdown files. I will try to create a proof-of-concept script, but it will take me a few days because I am not a programmer and will need to learn some Python programming first.
Solution description
-
In Settings > Export configure 'Ref' to 'Anchor text with block URL'. After doing this, a link to another block in a SiYuan note appears in the exported Markdown file as
[Anchor text](siyuan://blocks/block-id). -
Write a Python script that opens each exported markdown file and uses regex matching to identify all instances of
[Anchor text](siyuan://blocks/block-id). For each instance, -
Use the
/api/query/sqlAPI endpoint to get details of theblock-idby making a query like:{ "stmt": "SELECT * FROM blocks WHERE id='block-id'" } -
In the query result, you can find the
hpathkey whose value is a human readable path.- If the block-id is for a block of type document (which would be the case for a link to another document), then the Python script just needs to replace
siyuan://blocks/block-idwith hpath_value.md which would be the relative path to the exported markdown file that the link points to. - If the block-id is for a block inside a document (e.g. to some arbitrary paragraph block in the document), all you need to do is to open the exported markdown document containing that paragraph (from the value of
hpathfor that block-id), find the start of the paragraph and add an<a name="block-id"></a>anchor at the start of the paragraph. Then, thesiyuan://blocks/block-idin the exported markdown file can be replaced byhpath_value.md#block-id
- If the block-id is for a block of type document (which would be the case for a link to another document), then the Python script just needs to replace
This would basically solve the problem of having correct links in the exported markdown files and additionally the exported notes can easily be converted to HTML and published e.g. with a static site generator like Hugo.
@88250 Do you see any problems with this approach? I don't understand why SiYuan does not do this already when exporting to markdown.. but in any case, a Python script that does the above can post-process the exported markdown files from SiYuan and fix all the links. What do you think?
1 Reply1 Operatesagar updated this reply at 2023-12-01 08:25:07 -
-
In theory, programs that support standard Markdown (CommonMark) should be able to support parsing and rendering inline HTML elements, that is,
<span>, but they may not necessarily support anchor hash jumps. After rendering from Markdown to HTML, the browser can support anchor hash jumping, so currently, exporting references as anchor hashs is the optimal solution.1 Reply -
adham • • 1Author
You're welcome! I actually was too lazy to write it myself so I asked ChatGPT to do it for me and changed some mistakes in its code.
And I might as well do it for non-document blocks, I will post the solution here too.
In any case, it seems like this problem can be solved easily and be integrated into SiYuan.
I am not familiar with SiYuan code or Golang in general so someone else more familiar may make a Pull Request for this feature way faster than me.
If not, I don't mind spending some time to learn enough to build this feature into SiYuan. It's the least I can do in return for getting this amazing app for free!
Thanks @88250 @sagar and long live the open source! - Visit all replies
Welcome to here!
Here we can learn from each other how to use SiYuan, give feedback and suggestions, and build SiYuan together.
Signup About