-
Notifications
You must be signed in to change notification settings - Fork 23
feat: interlinks autolink #395
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
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #395 +/- ##
=======================================
Coverage 88.80% 88.80%
=======================================
Files 40 40
Lines 3010 3010
=======================================
Hits 2673 2673
Misses 337 337 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I'm having such a good time with this feature, I can't believe it took so long to come around to it! |
This WIP PR automatically formats code as interlinks. Addresses #328
Essentially:
interlinks.autolinks = True
setting, that turns inline Code directly to links.[](`some_function`)
syntax.~
. I don't think it would be confusing for this approach.~a.b.c
when interlinks still uses~a.b.c
for the link text (use full link syntax for name shortening)~a.b.c
when unmatched returns the original code~a.b.c
interlinks.aliases
to allow linking functions likequartodoc.Auto
by just writingAuto
.qd-no-link
class to tell quartodoc not to try interlinking. E.g.`my_func`{.qd-no-link}
Alias example
thinking about
Basically we need to ensure: