Skip to content

Conversation

zampino
Copy link
Collaborator

@zampino zampino commented Apr 12, 2023

Extend markdown syntax in prose to accept [[internal-link]] where internal-link works with:

  • a path to a notebook absolute or relative to project root ([[notebooks/rule_30.clj]])
  • a requirable namespace ([[rule-30]])
  • a qualified symbol pointing to a resolvable var ([[rule-30/first-generation]])

We consider allowing this ambiguity in the syntax, and give precedence to paths pointing to existing files.

@zampino zampino force-pushed the internal-links branch 2 times, most recently from edd58fd to f40a6f0 Compare April 13, 2023 16:33
Base automatically changed from live-doc-url to main April 21, 2023 08:42
@zampino zampino marked this pull request as ready for review April 24, 2023 12:35
@zampino zampino marked this pull request as draft April 27, 2023 07:44
@zampino
Copy link
Collaborator Author

zampino commented May 30, 2023

Closing this as we decided to process all regular [text](url) links' hrefs from prose as per clerk/doc-url when sensible.

We might reserve the [[wiki]] syntax for more complex handling in the future, like linking by namespace/var or notebook title once we agree on a way to expose a canonical list of notebooks in the context of clerk/show!. @sritchie for instance, is suggesting to pass clerk/serve! the same options that are passed to clerk/build!.

@zampino zampino closed this May 30, 2023
@zampino zampino mentioned this pull request Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants