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

Crossreferences support #149

Open
tetromino opened this issue Mar 13, 2023 · 0 comments
Open

Crossreferences support #149

tetromino opened this issue Mar 13, 2023 · 0 comments

Comments

@tetromino
Copy link
Collaborator

(As suggested by @rickeylev) Markdown has primitive support for cross-references: you can linkify a term (e.g. [`FooInfo`]) and it will be linked to a named url reference FooInfo, which can be e.g. provided elsewhere on the page - perhaps automatically appended to the documentation page by Stardoc's markdown processor.

We might want to use this mechanism in the following ways:

  • automatically linkifying standard starlark and build language types, globals, etc.;
  • allowing a stardoc rule to specify a custom crosslinks.md input which will get appended to generated markdown output;
  • (stretch goal) perhaps automatically linkifying refernces to other rules found in BCR?

CC @comius

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

No branches or pull requests

1 participant