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

Convert links to local files in markdown #618

Closed
znz opened this issue Apr 11, 2018 · 4 comments
Closed

Convert links to local files in markdown #618

znz opened this issue Apr 11, 2018 · 4 comments

Comments

@znz
Copy link
Member

znz commented Apr 11, 2018

Original issue is Some links broken in README .
I found two problem.

  1. COPYING, CONTRIBUTING.md, etc. are not in https://docs.ruby-lang.org/en/trunk/.
  2. links to local files in markdown do not convert to links to converted html files.

I added missing files to .document, but they are still broken links because rdoc does not convert links to local files.

@aycabta
Copy link
Member

aycabta commented May 4, 2018

The README.md uses link notation.

## Contributing

See the file [CONTRIBUTING.md](CONTRIBUTING.md)

I guess that this is just for GitHub and I think that RDoc's behavior is correct. You can use rdoc-ref(example, raw and generated).

@aycabta aycabta closed this as completed May 4, 2018
@aycabta
Copy link
Member

aycabta commented May 4, 2018

Just to be safe, please use rdoc-ref without extension. For example, [CONTRIBUTING.md](CONTRIBUTING).

@znz
Copy link
Member Author

znz commented May 5, 2018

[COPYING](COPYING) and [win32/README.win32](win32/README.win32) are without extension.
Should they be [COPYING](rdoc-ref:COPYING) and [win32/README.win32](rdoc-ref:win32/README.win32)?
Is there no way to generate valid link on github and rdoc generated html?

@aycabta
Copy link
Member

aycabta commented May 5, 2018

You can use [COPYING](rdoc-ref:COPYING), but [win32/README.win32](rdoc-ref:win32/README.win32) is failed. I guess this is a bug, so I'll survey this issue later.

We can't generate valid links for both of GitHub UI and HTML files by Darkfish. Is it important? I think that GitHub's UI isn't important for Ruby. And, I don't want to optimize RDoc for GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants