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

Click recording://entity/path links in markdown #3442

Merged
merged 26 commits into from
Sep 25, 2023

Conversation

emilk
Copy link
Member

@emilk emilk commented Sep 25, 2023

What

You can now embed links to entities in markdown documents using recording://entity/path, and link to components using recording://entity/path.Color.

In order to support this, a new DataPath is introduced, with a stricter parsing of entity paths. Previously foo bar was a valid path, but now you are only allowed ASCII, numbers, underscore and dash as names (outside of quotes).

A (uncompleted) description of the SfM example as markdown to

  • Test how that feels as documentation
  • Try out the ability to link directly to entities and components from within the markdown

image

image

Checklist

@emilk emilk changed the title Emilk/markdown example rebased Click recording://entity/path links in markdown Sep 25, 2023
@emilk emilk added 📺 re_viewer affects re_viewer itself include in changelog labels Sep 25, 2023
@emilk emilk marked this pull request as ready for review September 25, 2023 09:50
@emilk
Copy link
Member Author

emilk commented Sep 25, 2023

Already reviewed in #3389

@emilk emilk merged commit e4e1ae7 into main Sep 25, 2023
27 of 29 checks passed
@emilk emilk deleted the emilk/markdown-example-rebased branch September 25, 2023 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants