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

Autolinks in documentation editor #11597

Merged
merged 34 commits into from
Nov 21, 2024
Merged

Autolinks in documentation editor #11597

merged 34 commits into from
Nov 21, 2024

Conversation

kazcw
Copy link
Contributor

@kazcw kazcw commented Nov 19, 2024

Pull Request Description

Autolinks in documentation

  • Markdown editor renders autolinks (<https://example.com>).
  • Markdown editor converts URLs in pasted text to autolink syntax.
  • Markdown editor supports raw paste (Shift+Ctrl+V), which doesn't autolink.
  • Markdown parser: disable GitHub-style unmarked autolinks, and some other unsupported GFM extensions.

Important Notes

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    TypeScript,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • Unit tests have been written where possible.
  • If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
    or the Snowflake database integration, a run of the Extra Tests has been scheduled.
    • If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

kazcw and others added 25 commits November 14, 2024 19:31
Also:
- Separate parser for our flavor of Markdown from the CodeMirror integration;
  move the parser into ydoc-shared and use for Markdown line-wrapping.
- Introduce our own version of yCollab extension; initially just the upstream
  version translated to Typescript and our code style.
- Refactor CodeEditor.
Also a little refactoring in preparation for new implementation.
Eliminates Lexical dependency. Stacked on #11575 and #31607.
- Markdown editor renders autolinks (`<https://example.com>`).
- Markdown editor converts URLs in pasted text to autolink syntax.
- Markdown editor supports raw paste (Shift+Ctrl+V), which doesn't autolink.
- Markdown parser no longer supports GitHub-style unmarked autolinks.
@kazcw kazcw self-assigned this Nov 19, 2024
@kazcw kazcw marked this pull request as ready for review November 19, 2024 21:29
@kazcw kazcw requested a review from Frizi as a code owner November 19, 2024 21:29
'image/png': { extension: 'png' },
'image/svg+xml': { extension: 'svg' },
'image/webp': { extension: 'webp' },
// Question: do we want to have BMP and ICO here?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talking with @Frizi we decided that we do not, but I forgot to remove this comment.

Base automatically changed from wip/kw/cm-comments to develop November 21, 2024 18:43
@kazcw kazcw added the CI: Ready to merge This PR is eligible for automatic merge label Nov 21, 2024
Copy link

github-actions bot commented Nov 21, 2024

🧪 Storybook is successfully deployed!

📊 Dashboard:

@jdunkerley jdunkerley merged commit c431a6b into develop Nov 21, 2024
53 checks passed
@jdunkerley jdunkerley deleted the wip/kw/doc-autolinks branch November 21, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI: Ready to merge This PR is eligible for automatic merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-linking in documentation editor
3 participants