danielfrg / mkdocs-jupyter

Use Jupyter Notebook in mkdocs
https://mkdocs-jupyter.danielfrg.com
Apache License 2.0
362 stars 45 forks source link

Relative links do not pointing to converted .html page #157

Open han16nah opened 12 months ago

han16nah commented 12 months ago

Neither with the notebook syntax [](), nor with <a href=''></a> syntax, relative URLs (to other jupyter notebooks and markdown files) are "working" in jupyter notebooks in the compiled documentation. I am not sure if this is related only to URLs in parent directories. Instead of linking to the converted .html files, they are linking to the .md files (i.e., the markdown source code is displayed in the browser) or the .ipynb files (which automatically downloads the file). Our mkdocs configurations can be found here: https://github.com/3dgeo-heidelberg/etrainee/blob/main/mkdocs/mkdocs.yml

Example:

https://3dgeo-heidelberg.github.io/etrainee/module3/02_pointcloud_programming_python/02_pointcloud_programming_python.html -> Link for the text "different file formats" -> will open the source code of the .md page, not a .html version (cf. opening links in the same way from a markdown file works, like on https://3dgeo-heidelberg.github.io/etrainee/module3/01_pointcloud_principles/01_pointcloud_principles.html

Code for this example:

{
   "attachments": {},
   "cell_type": "markdown",
   "id": "d0b27d57",
   "metadata": {},
   "source": [
    "In order to process point cloud data in Python, the data needs to be read from files into the working memory. Results of the processing should be written to point cloud files again. Point cloud data can be stored in [different file formats](../01_pointcloud_principles/01_pointcloud_principles.md). Throughout this theme, we will focus on the LAS format, as it is a binary format with low file sizes and the de-facto standard of point cloud data. For this, the [laspy](https://pypi.org/project/laspy/) package will be used (version >= 2.0)."
   ]
  },

On GitHub, the file is here

Problem might be related to:

han16nah commented 3 months ago

Are there any news on this issue?