Wikilinks #553
Draft
Wikilinks #553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zampino
force-pushed
the
doc-browser--wikilinks
branch
from
524721e
to
26d4caa
Compare
author Andrea Amantini <lo.zampino@gmail.com> 1680188333 +0200 committer Andrea Amantini <lo.zampino@gmail.com> 1693237293 +0200 Add internal-link tokenizer Make basic example functional Allow internal links to namespaces Make internal link scroll to var Put the notebook title as link content Make linter happy Refactor Fix hash fragment in links to var Omit reader quote-var dispatch in link text Kondo Include notebook presentation in doc-url rebinding scope Simplify Explain Coherent keys Handle fragments from vars Naming Reduce noise
zampino
force-pushed
the
doc-browser--wikilinks
branch
from
4448306
to
589e007
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds wikilinks syntax. In the general context of a Clerk notebook's prose, such links will lead to the notebook associated to the (var's) namespace.
[[some-ns]][[some/qualified-var]]We also support internal links via a notebook's path, in this case the title of the notebook will be displayed.
[[path-to-notebook]]The same applies to regular links
[Some Label](var-or-ns-or-path-to-notebook).In the context of the doc browser, internal links behave as described in cljdoc. In particular
[[some-var]]in the current namespace will scroll to the correct height in the page.Resuscitates #451.