Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs linkgenerated broken on local #437

Open
c0ncentus opened this issue Mar 16, 2023 · 1 comment
Open

docs linkgenerated broken on local #437

c0ncentus opened this issue Mar 16, 2023 · 1 comment
Labels
➖ wontfix This will not be worked on 🌷 enhancement New feature or request

Comments

@c0ncentus
Copy link

c0ncentus commented Mar 16, 2023

Describe the bug
when npx fliegdoc build and then

image

on local have link broken
image

or even worse
image

To Reproduce
Basic usage, no config

  1. whatever project
  2. npm i --save fliegdoc && npx fliegdoc build
  3. open index.html on doc/
  4. See error on links

Expected behavior
userelative instead "/index.html"
and "/lord_ts/index.html".

works on local and on a website router rendering ...

Desktop (please complete the following information):

  • OS: Windows 10
  • Browser Firefox latest
@pklaschka pklaschka added the 🌷 enhancement New feature or request label Mar 17, 2023
@pklaschka
Copy link
Member

pklaschka commented Mar 17, 2023

Thanks for creating the issue!

At the moment, the individual views (which could be seen as components for various pieces of the documentation) work without knowing “which file it is in“, so to speak, making handling links a lot easier (not requiring conditional logic). However, this would need to change for relative links to work correctly.

Since there are two “serve” options (one for the built documentation with fliegdoc build -s, and one without building the docs in the file system with fliegdoc serve), I don’t see such support as a high priority for this project (which I want to be focused more on being somewhat minimalistic with a dedicated focus to a limited set of capabilities).

If someone wants to contribute to this feature, I'm happy to discuss (and potentially then accept) contributions if the following requirements are met:

  1. the feature is optional (also allowing for absolute links, which can be helpful in some cases), e.g., by providing a ./ as the base URL in the config file
  2. no complexity in the template/view files (they should be focused on their structure and not resolving links)
  3. URLs remain pretty by default (i.e., not explicitly including index.html).
  4. the full (no config needed, out of the box) compatibility with online deployment environments, both with and without trailing slashes, has the highest priority

I will keep this issue open in case anyone wants to take this on, but I don't consider this a priority and will probably not implement it myself.

@pklaschka pklaschka added the ➖ wontfix This will not be worked on label Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
➖ wontfix This will not be worked on 🌷 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants