-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 💄 style: Prettier formatting * 📚 docs: Update vitepress theme, change hero, add headers * 🔧 chore: Run Prettier in QA workflow * 💄 style: Sync code highlight theme between code and sandpack * 🧪 test: Fix tests coverage * 🐛 fix: Fix external link icon when link is multiline * 🔧 chore: Change base url * 💄 style: Fix prettier
- Loading branch information
1 parent
f7b8546
commit 3106937
Showing
36 changed files
with
849 additions
and
493 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,4 +31,4 @@ | |
"status": "MIT" | ||
} | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import { defineConfig } from 'vitepress'; | ||
import { markdown } from './config/markdown'; | ||
import { head } from './config/en/head'; | ||
import { nav } from './config/en/nav'; | ||
import { sidebar } from './config/en/sidebar'; | ||
|
||
export default defineConfig({ | ||
title: 'CDN Client', | ||
titleTemplate: 'Localazy CDN Client', | ||
description: 'Localazy CDN Client Documentation', | ||
|
||
lang: 'en-US', | ||
base: '/', | ||
head: head(), | ||
lastUpdated: true, | ||
markdown: markdown(), | ||
|
||
sitemap: { | ||
hostname: 'https://localazy.github.io/cdn-client/', | ||
}, | ||
|
||
themeConfig: { | ||
logo: { | ||
src: '/theme/localazy-logo.svg', | ||
width: 24, | ||
height: 24, | ||
}, | ||
nav: nav(), | ||
sidebar: sidebar(), | ||
socialLinks: [ | ||
{ icon: 'npm', link: 'https://www.npmjs.com/package/@localazy/cdn-client' }, | ||
{ icon: 'github', link: 'https://github.com/localazy/cdn-client' }, | ||
], | ||
search: { | ||
provider: 'local', | ||
}, | ||
externalLinkIcon: true, | ||
}, | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
import { HeadConfig } from 'vitepress'; | ||
|
||
export const head = (): HeadConfig[] => [ | ||
// Favicon | ||
['link', { rel: 'icon', href: '/cdn-client/favicon.ico', sizes: '32x32' }], | ||
['link', { rel: 'icon', href: '/cdn-client/theme/localazy-logo.svg', type: 'image/svg+xml' }], | ||
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/cdn-client/theme/apple-touch-icon.png' }], | ||
|
||
// Fonts | ||
[ | ||
'link', | ||
{ | ||
rel: 'stylesheet', | ||
href: 'https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,300;0,400;0,500;0,700;0,900;1,100;1,300;1,400;1,500;1,700;1,900&display=swap', | ||
}, | ||
], | ||
|
||
// Open Graph protocol | ||
['meta', { name: 'theme-color', content: '#066fef' }], | ||
['meta', { property: 'og:type', content: 'website' }], | ||
['meta', { property: 'og:locale', content: 'en' }], | ||
['meta', { property: 'og:title', content: 'Localazy CDN Client | Documentation' }], | ||
['meta', { property: 'og:site_name', content: 'Localazy CDN Client' }], | ||
[ | ||
'meta', | ||
{ | ||
property: 'og:description', | ||
content: 'Node.js module that allows you to easily interact with the Localazy CDN.', | ||
}, | ||
], | ||
[ | ||
'meta', | ||
{ | ||
property: 'og:image', | ||
content: 'https://localazy.github.io/cdn-client/cdn-client/theme/localazy-cdn-client-og.png', | ||
}, | ||
], | ||
['meta', { property: 'og:url', content: 'https://localazy.github.io/cdn-client/' }], | ||
|
||
// Twitter card | ||
['meta', { property: 'twitter:card', content: 'summary_large_image' }], | ||
['meta', { property: 'twitter:url', content: 'https://localazy.github.io/cdn-client/' }], | ||
['meta', { property: 'twitter:title', content: 'Localazy CDN Client | Documentation' }], | ||
[ | ||
'meta', | ||
{ | ||
property: 'twitter:description', | ||
content: 'Node.js module that allows you to easily interact with the Localazy CDN.', | ||
}, | ||
], | ||
[ | ||
'meta', | ||
{ | ||
property: 'twitter:image', | ||
content: 'https://localazy.github.io/cdn-client/cdn-client/theme/localazy-cdn-client-og.png', | ||
}, | ||
], | ||
]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import { DefaultTheme } from 'vitepress/theme'; | ||
import { version } from '../../../../package.json'; | ||
|
||
export const nav = (): DefaultTheme.NavItem[] => [ | ||
{ | ||
text: 'Get Started', | ||
link: '/get-started/introduction', | ||
activeMatch: '/get-started/', | ||
}, | ||
{ | ||
text: version, | ||
items: [ | ||
{ | ||
text: 'Releases', | ||
link: 'https://github.com/localazy/cdn-client/releases', | ||
}, | ||
{ | ||
text: 'Changelog', | ||
link: 'https://github.com/localazy/cdn-client/blob/main/CHANGELOG.md', | ||
}, | ||
], | ||
}, | ||
]; |
Oops, something went wrong.