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?
1 Reference
Related articles
-
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 -
- MiscReply
-
sagar •VIP Warrior
@adham Wow 😍 You are a master programmer indeed! I was still trying to figure out how to use Python to open all .md files in a directory, by copy/pasting code from Stackoverflow 😄 This solution is exactly what I meant.
I do believe it can be extended to include references to any arbitrary block, not just a document block. You did say that you don't want to mutate the linked documents, but I am just laying out the approach in case any other master programmers want to try it 😄. You wrote,
I don't know how to find out if the link is of a block or a document,
I see a few different possible checks for this
- Look at the 'type' field in the response of the SQL query. If it is a document block, the type value will be 'd'. Other type values are given in the documentation at /Please Start Here/Advanced search/Type filtering
- I believe that if the block is of type document, then the 'root_id' will be the same as 'id'. See the documentation of the SQL table fields at /Please Start Here/Advanced search/Database table
So one or both of the above checks can be used to determine if the block is of type 'document' or something else.
If the block is of type something else, then the way to link to it would be
- Open the target document that contains the block (i.e. the hpath)
- Search for the occurrence of the content in the 'markdown' field of the SQL query response. This will place the "cursor" inside the document to the start of the paragraph (or whatever other content) the block points to
- At this cursor position, insert an HTML anchor text like:
<a name="block-id"></a> - Then, update the
siyuan://blocks/block-idpart of the link tohpath_value.md#block-id
This approach enables having links in the markdown files to any other markdown files or parts inside markdown files.
@adham Thank you once again for your example code 🙏
-
Siysuy •
I think the issue remains with
anchor hashfor the reason that it is limited to notebook currently, meaning I cannot select rendering from Markdown to HTML from thenotebook_ex > export > (selectable=Markdown/siyuan.sy.zip).How would i export my notes to HTML with
anchor hash? I think I would be limited to usingpandoc input.md -o output.html, I tried it with pandoc, which succesfully creates html with link to other note, but it just opens the other note without navigation to the<span>block, so no hash jump in browser (brave/firefox) to block.1 Reply -
The reason why this function is placed at the notebook level is because some users no longer want to use SiYuan and need complete batch export, so support for this function is not considered at the document level.
I'm not sure if the span tag still exists after pandoc converts the HTML, but I'm sure anchor jumps can be used and you can write HTML tests in the browser.
1 Reply - 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