Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xiaoluoboding/metafy-svg
Easily crawl a website's metadata and generate SVG as a service.
https://github.com/xiaoluoboding/metafy-svg
crawler metadata saas serverless-functions svg vercel-serverless
Last synced: 3 months ago
JSON representation
Easily crawl a website's metadata and generate SVG as a service.
- Host: GitHub
- URL: https://github.com/xiaoluoboding/metafy-svg
- Owner: xiaoluoboding
- License: mit
- Created: 2022-10-03T11:29:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-08T05:51:39.000Z (over 2 years ago)
- Last Synced: 2024-10-12T02:43:25.789Z (4 months ago)
- Topics: crawler, metadata, saas, serverless-functions, svg, vercel-serverless
- Language: TypeScript
- Homepage: https://svg.bookmark.style/api?url=https://onetab.group&mode=light
- Size: 248 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Metafy SVG
> Easily crawl a website's metadata and generate SVG as a service.
## Render In README.md
You can render the bookmark.style card as a SVG in the GitHub README.md now.
### Code
```markdown
[](https://onetab.group)
```
### Preview
| Card Style | Light Mode | Dark Mode |
| :----------: | :------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------: |
| Twitter Like |  |  |
| Notion Like |  |  |
### Customize the gradient color
The hex color in the URL can not contain the `#` character, so you can write like this `#000000` to `000000`
#### Type
```ts
type GradidentColor = {
formColor: string
viaColor?: string
toColor: string
}
```
#### URL
```bash
curl https://svg.bookmark.style/api?url=$URL&formColor=$FROM_COLOR&viaColor=$VIA_COLOR&toColor=$TO_COLOR
```
#### Demo without `viaColor`
```bash
https://svg.bookmark.style/api?url=https://onetab.group&mode=light&fromColor=fa4&toColor=a4f
```
#### Demo with `viaColor`
```bash
https://svg.bookmark.style/api?url=https://onetab.group&mode=light&fromColor=fa4&viaColor=4af&toColor=a4f
```
## Usage
Enter a valid `$URL` as params
```bash
curl https://svg.bookmark.style/api?url=$URL
```
## Types
```ts
type Params = {
url: string
mode?: 'light' | 'dark'
style?: 'vertical' | 'horizontal'
formColor?: string
viaColor?: string
toColor?: string
}
```
## Example
### Input
```bash
curl https://svg.bookmark.style/api?url=https://onetab.group&mode=light
```
### Output
[](https://onetab.group)
## Deploy your own instance
Deploy your `Metafy` on your own instance with one-click.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fxiaoluoboding%2Fmetafy-svg)
## Tech Stack
- [vercel](https://vercel.com/) - Develop. Preview. Ship. For the best frontend teams.
- [metascraper](https://metascraper.js.org/) - metascraper, easily scrape metadata from an article on the web.
- [typescript](https://www.typescriptlang.org/) - Typed JavaScript at Any Scale.
- [got](https://github.com/sindresorhus/got) - 🌐 Human-friendly and powerful HTTP request library for Node.js
- [html-escaper](https://github.com/WebReflection/html-escaper) - A simple module to escape/unescape common problematic entities.
- [esno](https://github.com/antfu/esno) - TypeScript / ESNext node runtime powered by esbuild
## License
MIT [xiaoluoboding](https://github.com/xiaoluoboding)