Skip to content

Commit

Permalink
fix: broken links (#1686)
Browse files Browse the repository at this point in the history
* refactor: use emoji as flag

* fix: broken links

* fix: linter

* fix: broken links
  • Loading branch information
Kikobeats committed Jan 28, 2024
1 parent e9a7a9d commit 14687e2
Show file tree
Hide file tree
Showing 23 changed files with 169 additions and 118 deletions.
2 changes: 1 addition & 1 deletion data/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
- date: October 2022
notes:
- '[Microlink](/): Improved website accessibility.'
- '[Microlink](/): Added [formats-supported](/formats-supported) benchmarking page.'
- '[Microlink](/): Added [/formats](/formats) benchmarking page.'

- date: September 2022
notes:
Expand Down
8 changes: 4 additions & 4 deletions data/features-screenshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
- title: Overlay Composition
description: Create [overlay](/docs/api/parameters/screenshot/overlay) compositions combining layers and backgrounds.
- title: Browser Events
description: Setup [waitUntil](/docs/api/parameters/waitUntil) and [waitFor](/docs/api/parameters/wait-for) to wait any quantity of time or CSS selector.
description: Using [waitUntil](/docs/api/parameters/waitUntil), [waitForSelector](/docs/api/parameters/waitForSelector), or [waitForTimeout](/docs/api/parameters/waitForTimeout) to await certain events.
- title: Device Emulation
description: A large list of [device](/docs/api/parameters/device) are supported for simulating scenarios and environments.
- title: Browser Automation
description: Ability to [hide](/docs/api/parameters/screenshot/hide), [click](/docs/api/parameters/screenshot/click) or [scroll](/docs/api/parameters/screenshot/scroll) to any element matching the given CSS Selector.
description: Ability to [click](/docs/api/parameters/click) or [scroll](/docs/api/parameters/scroll) to any element matching the given CSS Selector.
- title: Embed Mode
description: Incrustate directly into Markdown, HTML or any other markup using [embed](/docs/api/parameters/embed).
- title: CSS/JS Injection
description: Inject any CSS or JavaScript code into the page.
- title: Fully Screenshot
description: Inject [styles](/docs/api/parameters/styles), [javascript](/docs/api/parameters/javascript) or [modules](/docs/api/parameters/modules) into the page.
- title: Full Screenshot
description: Using [fullPage](/docs/api/parameters/screenshot/fullPage) for exporting the entire page as screenshot.
- title: File Format
description: Configurable [type](/docs/api/parameters/screenshot/type) support with on-fly WebP support.
5 changes: 3 additions & 2 deletions src/pages/blog/browser-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Just [url](/docs/api/parameters/url) is the only parameter that needs to be spec
- [audio](/docs/api/parameters/audio): enables audio source detection from the target URL.
- [data](/docs/api/parameters/data): gets specific content extraction from the target URL.
- [filename](/docs/api/parameters/filename): defines the filename asset generated.
- [function](/docs/api/parameters/function): runs JavaScript code with runtime access to a headless browser.
- [iframe](/docs/api/parameters/iframe): gets, if it's possible, the embedded representation of the target URL.
- [insights](/docs/api/parameters/insights): gets lighthouse performance metrics from the target URL.
- [meta](/docs/api/parameters/meta): gets unified medata from the target URL.
Expand All @@ -39,7 +40,7 @@ Just [url](/docs/api/parameters/url) is the only parameter that needs to be spec
- [colorScheme](/docs/api/parameters/colorScheme): sets preferred browser color theme preference.
- [device](/docs/api/parameters/device): emulates an specific device (viewport, user agent, dimensions, etc).
- [javascript](/docs/api/parameters/javascript): enable/disable the javascript engine on the entire browser page.
- [mediaType](/docs/api/parameters/media-type): changes the CSS media type of the page.
- [mediaType](/docs/api/parameters/mediaType): changes the CSS media type of the page.
- [modules](/docs/api/parameters/modules): injects `<script type="module">` into the browser page.
- [ping](/docs/api/parameters/ping): enable/disable to resolve all URLs present into the payload.
- [prerender](/docs/api/parameters/prerender): enable/disable browser navigation.
Expand All @@ -50,7 +51,7 @@ Just [url](/docs/api/parameters/url) is the only parameter that needs to be spec
- [styles](/docs/api/parameters/styles): injects `<style>` into the browser page.
- [viewport](/docs/api/parameters/viewport): establishes a set of properties related with the browser visible area.
- [waitForSelector](/docs/api/parameters/waitForSelector): waits for a CSS selector(s) to appear in page.
- [waitForTimeout](/docs/api/parameters/wait-for): waits a quantity of time in milliseconds before processing the content of the browser page.
- [waitForTimeout](/docs/api/parameters/waitForTimeout): waits a quantity of time in milliseconds before processing the content of the browser page.
- [waitUntil](/docs/api/parameters/waitUntil): waits browser event(s) before considering navigation succeeded.

## Response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ Now the value is resolved properly 👌.

## Combine it with the rest of API Parameters

One thing that makes [Microlink API](/docs/api/getting-started/overview) powerful is that you can combine every [API Parameter](/docs/api/#api-parameters) to work together.
One thing that makes [Microlink API](/docs/api/getting-started/overview) powerful is that you can combine every [API Parameter](/docs/api/getting-started/overview) to work together.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion src/pages/blog/microlink-for-pdf.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Enabling the new [pdf](/docs/api/parameters/pdf) query parameter will add a `pdf

The PDF file created as output of the process is hosted on [Microlink CDN](/blog/edge-cdn/) and it can be combined with [ttl](/docs/api/parameters/ttl) to automatically refresh in the background, providing an updated PDF representation of the target URL.

Additionally, a set of new query parameters have been added for better PDF accommodation, such as [scale](/docs/api/parameters/pdf/scale), [margin](/docs/api/parameters/pdf/margin) and [media](/docs/api/parameters/pdf/media).
Additionally, a set of new query parameters have been added for better PDF accommodation, such as [scale](/docs/api/parameters/pdf/scale), [margin](/docs/api/parameters/pdf/margin) and [mediaType](/docs/api/parameters/mediaType).

These query parameters are specially helpful when the target URL is not actually prepared to be properly exported as PDF.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/blog/product-brief-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ We also want to provide examples, and ways to integrate it with popular framewor

Maintaining documentation is laborious and requires effort. We needed to combine **all** the documentation associated with [microlink.io](https://microlink.io) into one place.

After comparing multiple approaches on the matter and seeing how other companies take on the challenge, we decided on [Vercel documentation](https://github.com/zeit/docs) portal.
After comparing multiple approaches on the matter and seeing how other companies take on the challenge, we decided on [Vercel documentation](https://github.com/vercel/docs) portal.

<Microlink size='large' url={'https://twitter.com/Kikobeats/status/956221717319421952'} />

Expand Down
2 changes: 1 addition & 1 deletion src/pages/blog/product-brief-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The easiest way to consume the frontend library. Just paste the corresponding sc
<script type="text/javascript" src="//unpkg.com/@microlink/vanilla@latest/cjs/microlink.min.js"></script>`}</PreCode>
```

See more [information](/docs/sdk/getting-started/overview/getting-started/vanilla).
See more [information](/docs/sdk/integrations/vanilla).

### From NPM

Expand Down
8 changes: 4 additions & 4 deletions src/pages/blog/product-brief-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ date: '2018-04-11'

### Release 2.0

We are happy to introduce the [SDK 2.0](/docs/sdk), the easiest way to add link previews in your website without effort.
We are happy to introduce the [SDK 2.0](/docs/sdk/getting-started/overview), the easiest way to add link previews in your website without effort.

The version 2.0 introduce a breaking change: It removes the `round` property from the [API Parameters](/docs/sdk/getting-started/overview/getting-started/api-parameters) that you can pass for customize the card preview.
The version 2.0 introduce a breaking change: It removes the `round` property from the [API Parameters](/docs/sdk/getting-started/overview) that you can pass for customize the card preview.

The property `round` was related with apply a `border-radius` around your preview card.

We decide make this little change in order the reduce the number of configurable [API Parameters](/docs/sdk/getting-started/overview/getting-started/api-parameters).
We decide make this little change in order the reduce the number of configurable [API Parameters](/docs/sdk/getting-started/overview).

But you can still extend the default style using CSS.

Expand Down Expand Up @@ -63,7 +63,7 @@ Read more about [styling](/docs/sdk/getting-started/overview/getting-started/van

### Video detection

In this product sprint we focused on improving our `video` property added into our [API](/docs/api/getting-started/overview) in the [previous product brief](/blog/video-support-prerendering-sdk-features).
In this product sprint we focused on improving our `video` property added into our [API](/docs/api/getting-started/overview) in the [previous product brief](/blog/product-brief-3).

We extended the original idea, adding support for detecting more video providers. The most popular internet sites are covered, such as

Expand Down
16 changes: 4 additions & 12 deletions src/pages/blog/product-brief-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ date: '2018-05-30'

## Microlink API

[![](https://i.imgur.com/2RNeKiR.png)](/docs/api)
[![](https://i.imgur.com/2RNeKiR.png)](/docs/api/getting-started/overview)

<Figcaption>
<Link href='/docs/api' children='Microlink API' /> examples was improved,
<Link href='/docs/api/getting-started/overview' children='Microlink API' /> examples was improved,
highlighting the referenced term in each section.
</Figcaption>

Expand All @@ -22,7 +22,7 @@ For example, is very common websites serve images on [WebP](https://en.wikipedia

### Video API Parameter

In the [previous](/blog/sdk-2-0-more-video-providers) Product Brief we introduced the first iteration of video support as part of the API supported data [types](/docs/api/getting-started/overview).
In the [previous](/blog/product-brief-3) Product Brief we introduced the first iteration of video support as part of the API supported data [types](/docs/api/getting-started/overview).

Although it's widely used when you consume the API response using our [SDK](/docs/sdk/getting-started/overview/), it can degrade the general user experience, making the response times a bit heavy, specially if you are only interested in the rest of data extracted by the API.

Expand All @@ -44,14 +44,6 @@ Some significant changes since the last time have been:
- **Add rules parameter support** doing possible load specific [rules](https://metascraper.js.org/#/?id=rules-1) out of the box.
- **Exported core validators** making possible [reuse](https://github.com/microlinkhq/metascraper/pull/89) them and creating consistent third party rules set.

This changes has been deployed at [Microlink API](/docs/api), adding support for a new shiny functionality called **Custom Rules**: The ability to tell the API new rules to extract new data.
This changes has been deployed at [Microlink API](/docs/api/getting-started/overview), adding support for a new shiny functionality called **Custom Rules**: The ability to tell the API new rules to extract new data.

We are preparing a new post explaining how to do that, staty stunned 🤘.

## Microlink Gallery

[![](https://i.imgur.com/gCq6WeX.png)](https://gallery.microlink.io/)

We started building a [gallery](https://gallery.microlink.io) of webs, apps or 🦄 who use microlink with some purpose.

Please [contact with us](https://twitter.com/microlinkhq) for add your shiny project there ✨.
4 changes: 2 additions & 2 deletions src/pages/blog/product-brief-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: '2018-06-30'

## Custom Rules

[![](https://i.imgur.com/subDjQ1.png)](https://microlink.io/blog/custom-rules)
[![](https://i.imgur.com/subDjQ1.png)](/blog/custom-rules)

<Figcaption>Custom Rules enables build custom API response based on your necessities.</Figcaption>

Expand All @@ -17,7 +17,7 @@ Now, we are introducing the concept of **Custom Rules**: The ability to setup cu

In other words, you can use it as a scraper as service 🤯.

We wrote a specific blog [post](https://microlink.io/blog/custom-rules) explaining how to use custom rules, taking an Instagram profile as an example.
We wrote a specific blog [post](/blog/custom-rules) explaining how to use custom rules, taking an Instagram profile as an example.

## Compression documentation

Expand Down
2 changes: 1 addition & 1 deletion src/pages/blog/product-brief-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ const { status, data } = await 'https://microlink.io'
console.log(data)
```

Microlink Query Language (_MQL_) is the precessor of [Custom Rules](/blog/introducing-custom-rules-/) as we pointed in our [Master Plan for 2019](/blog/master-plan-2019/).
Microlink Query Language (_MQL_) is the precessor of [Custom Rules](/blog/custom-rules) as we pointed in our [Master Plan for 2019](/blog/master-plan-2019/).

We are happy to say that **MQL is production ready** 🚀.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/api/parameters/audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ The audio detection introduce some human readable fields as part of the payload:
}
```

You can read [data fields](/api/getting-started/data-fields/) section to know more about the data returned.
You can read [data fields](/docs/api/getting-started/data-fields) section to know more about the data returned.
2 changes: 1 addition & 1 deletion src/pages/docs/api/parameters/embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ In this way, you can embed any data field directly as part of your HTML markup.

In order to authenticate your requests, you should use [proxy](https://github.com/microlinkhq/proxy) and [edge-proxy](https://github.com/microlinkhq/edge-proxy) to don't expose your credentials.

Read more about that at [authentication](/docs/api/parameters/authentication) section.
Read more about that at [authentication](/docs/api/basics/authentication) section.
4 changes: 2 additions & 2 deletions src/pages/docs/api/parameters/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ It runs JavaScript code with runtime access to a headless browser.
The function will receive any query parameter provided, plus:

- `html`: The target [url](/docs/api/parameters/url) HTML markup.
- `page`: The [puppeteer#page](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#class-page) to interact with the headless browser.
- `response`: The [puppeteer#response](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#class-httpresponse) as result of the implicit [page.goto](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagegotourl-options).
- `page`: The [puppeteer#page](https://pptr.dev/api/puppeteer.page/) to interact with the headless browser.
- `response`: The [puppeteer#response](https://pptr.dev/api/puppeteer.httpresponse/) as result of the implicit [page.goto](https://pptr.dev/api/puppeteer.page.goto/).

## Compression

Expand Down
Loading

2 comments on commit 14687e2

@vercel
Copy link

@vercel vercel bot commented on 14687e2 Jan 28, 2024

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

www – ./

www-git-master-microlink.vercel.app
www.microlink.io
www-microlink.vercel.app
microlink.io

@vercel
Copy link

@vercel vercel bot commented on 14687e2 Jan 28, 2024

Choose a reason for hiding this comment

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

Please sign in to comment.