GDQuest / GDQuest/gdscript-docs-maker

Cross reference links can lead to 404 pages

Ouverte
#47 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
bug
Langage dominant
Python
Étoiles
297
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

The latest version of the program supports cross-references like `[ClassName.method]`, etc. but the links don't always work. Part of the problem cannot be fixed without input from the user.

## The problem

When previewing markdown documents on your desktop, the links should point to markdown files to work, as you're browsing through your file system. E.g. `ClassName.md`

If you convert to html and/or put the files on the web, the links should point to the page's name or file, `./ClassName` or `./ClassName.html` or the lowercase equivalents.

Hugo may change the case of the links depending on the website's settings I believe?

## Solution

For markdown, I'm currently linking to `../PageName`. This *should* work if you put your pages online with a CMS, but it won't if you output your files as html directly. To solve this, we might need to have an html output that writes links as `../pagename.html#header-name`. We can look at how Sphinx and the Godot docs handle that.

In the hugo format, links should probably use the `{{< relref >}}` shortcode. This shortcode takes a relative path to a markdown document and resolves the final path for you. We have the exact name of the markdown documents so this would work reliably.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Aucun fichier source ni aucun test n’est indiqué. Repérez les points d’entrée de la génération des liens de références croisées pour les sorties Markdown, HTML et Hugo, puis comparez les chemins attendus décrits ici avec le comportement de la documentation Sphinx et Godot ; le travail est considéré comme terminé lorsque les liens générés fonctionnent pour le Markdown de bureau, le HTML direct et les sites Hugo.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
html, hugo, markdown, python
Domaine
documentation
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.