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

docs: api docs fixed markdown links #4260

Merged
merged 2 commits into from
Jun 5, 2023
Merged

docs: api docs fixed markdown links #4260

merged 2 commits into from
Jun 5, 2023

Conversation

zanettin
Copy link
Collaborator

@zanettin zanettin commented May 18, 2023

Overview

What is it?

  • Feature / enhancement
  • Bug
  • Docs / tests / types / typos

Description

Fixed markdown links in the API docs. thx @wmertens for the heads-up 🙏

Screenshots

Before

Bildschirmfoto 2023-05-18 um 21 49 38

After

Bildschirmfoto 2023-05-18 um 21 49 49

Light overview color adjustment

Bildschirmfoto 2023-05-18 um 21 49 04

Checklist:

  • My code follows the developer guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • Added new tests to cover the fix / functionality

@zanettin zanettin added the COMP: docs Improvements or additions to documentation label May 18, 2023
@stackblitz
Copy link

stackblitz bot commented May 18, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@@ -118,7 +118,7 @@ export interface QwikLoaderOptions

| Property | Modifiers | Type | Description |
| -------------- | --------- | ----------------------------- | ------------ |
| [events?](#) | | string\[\] | _(Optional)_ |
| [events?](#) | | string[] | _(Optional)_ |
Copy link
Member

Choose a reason for hiding this comment

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

Is this correct? Shouldn't this stay the same since it's not a link?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks for the review @wmertens 🙏 it shouldn't affect the output though. it's escaped by the api extractor but not needed to be imo on an .md file. do you see an issue with it? thanks again for your input 😃

@zanettin zanettin enabled auto-merge (squash) June 5, 2023 19:25
@cloudflare-pages
Copy link

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 606e772
Status: ✅  Deploy successful!
Preview URL: https://98b76e68.qwik-docs.pages.dev
Branch Preview URL: https://fix-api-markdown-links.qwik-docs.pages.dev

View logs

@zanettin zanettin merged commit 8d1a2c3 into main Jun 5, 2023
22 checks passed
@zanettin zanettin deleted the fix/api-markdown-links branch June 5, 2023 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMP: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants