github_mirrors/ua-parser-js
3
0
Fork 1
mirror of https://github.com/faisalman/ua-parser-js.git synced 2025-09-27 07:58:45 +03:00
Code Issues Packages Projects Releases Wiki Activity
ua-parser-js/docs/v2/.vitepress/config.js
Faisal Salman 9170c67964 Initial work for docs using VitePress
2023-04-11 10:41:55 +07:00

151 lines
7.8 KiB
JavaScript
Raw Blame History

import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
base: "/ua-parser-js/docs/v2/",
title: "UAParser.js",
titleTemplate: 'Detect Browser, OS, CPU, & Device with JavaScript',
description: "Detect Browser, OS, CPU, & Device with JavaScript",
head: [[
'link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/images/logo.png" }],
['script', {}, 'window?.localStorage?.setItem("vitepress-theme-appearance", window?.localStorage?.getItem("vitepress-theme-appearance") ?? "dark")'],
],
appearance : 'dark',
lastUpdated : true,
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: '/images/logo.png',
nav: [
{ text: 'Home', link: '/' },
{
text: '2.0.0-alpha',
items: [
{
text: 'Changelog',
link: 'https://github.com/faisalman/ua-parser-js/blob/master/changelog.md'
},
{
text: 'Contributing',
link: 'https://github.com/faisalman/ua-parser-js#development'
}
]
}
],
sidebar: [
{
text: 'Introduction',
collapsed: false,
items: [
{ text: 'Why UAParser.js', link: '/intro/why-ua-parser-js' },
{
text: 'Quick Start',
link: '/intro/quick-start/quick-start',
collapsed: true,
items: [
{ text: 'Using HTML', link: '/intro/quick-start/using-html' },
{ text: 'Using Node.js', link: '/intro/quick-start/using-node-js' },
{ text: 'Using ES Modules', link: '/intro/quick-start/using-es-modules' },
{ text: 'Using TypeScript', link: '/intro/quick-start/using-typescript' },
{ text: 'Using jQuery', link: '/intro/quick-start/using-jquery' },
]
},
{ text: 'Extending Regex', link: '/intro/extending-regex' },
]
},
{
text: 'API Reference',
items: [
{
text: 'UAParser',
collapsed: false,
link: '/api/ua-parser-js/overview',
items: [
{ text: 'Overview', link: '/api/ua-parser-js/overview' },
{ text: 'getBrowser()', link: '/api/ua-parser-js/get-browser' },
{ text: 'getCPU()', link: '/api/ua-parser-js/get-cpu' },
{ text: 'getDevice()', link: '/api/ua-parser-js/get-device' },
{ text: 'getEngine()', link: '/api/ua-parser-js/get-engine' },
{ text: 'getOS()', link: '/api/ua-parser-js/get-os' },
{ text: 'getResult()', link: '/api/ua-parser-js/get-result' },
{ text: 'getUA()', link: '/api/ua-parser-js/get-ua' },
{ text: 'setUA()', link: '/api/ua-parser-js/set-ua' },
{
text: 'IData',
collapsed: true,
items: [
{ text: 'is()', link: '/api/idata/is' },
{ text: 'toString()', link: '/api/idata/to-string' },
{ text: 'withClientHints()', link: '/api/idata/with-client-hints' },
{ text: 'withFeatureCheck()', link: '/api/idata/with-feature-check' }
]
}
]
}
]
},
{
text: 'Submodules',
items: [
{ text: 'ua-parser-js/enums', link: '/api/submodules/enums' },
{ text: 'ua-parser-js/extensions', link: '/api/submodules/extensions' },
{ text: 'ua-parser-js/maps', link: '/api/submodules/maps' }
]
}
],
socialLinks: [
{
icon: {
svg: '<svg color="#fff" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>'
}, link: 'https://github.com/faisalman/ua-parser-js'
},
{
icon: {
svg: '<svg color="#CB3837" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>npm</title><path d="M1.763 0C.786 0 0 .786 0 1.763v20.474C0 23.214.786 24 1.763 24h20.474c.977 0 1.763-.786 1.763-1.763V1.763C24 .786 23.214 0 22.237 0zM5.13 5.323l13.837.019-.009 13.836h-3.464l.01-10.382h-3.456L12.04 19.17H5.113z"/></svg>'
},
link: 'https://www.npmjs.com/package/ua-parser-js'
},
{
icon: {
svg: '<svg color="#7FADF2" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Open Collective</title><path d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12c2.54 0 4.894-.79 6.834-2.135l-3.107-3.109a7.715 7.715 0 1 1 0-13.512l3.107-3.109A11.943 11.943 0 0 0 12 0zm9.865 5.166l-3.109 3.107A7.67 7.67 0 0 1 19.715 12a7.682 7.682 0 0 1-.959 3.727l3.109 3.107A11.943 11.943 0 0 0 24 12c0-2.54-.79-4.894-2.135-6.834z"/></svg>'
},
link: 'https://opencollective.com/ua-parser-js'
},
{
icon: {
svg: '<svg color="#5B0BB5" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Demo</title><path d="M12 0a1.44 1.44 0 0 0-.947.399L.547 10.762a1.26 1.26 0 0 0-.342.808v11.138c0 .768.53 1.292 1.311 1.292h20.968c.78 0 1.311-.522 1.311-1.292V11.57a1.25 1.25 0 0 0-.34-.804L15.68 3.097h-.001L12.947.4A1.454 1.454 0 0 0 12 0Zm0 6.727 6.552 6.456v5.65H5.446v-5.65z"/></svg>'
},
link: 'https://faisalman.github.io/ua-parser-js'
},
],
carbonAds: {
code: 'your-carbon-code',
placement: 'your-carbon-placement'
},
footer: {
message: 'Licensed under the MIT License.',
copyright: 'Copyright © 2012-2023 Faisal Salman'
},
lastUpdatedText : 'Updated Date',
editLink: {
pattern: 'https://github.com/faisalman/ua-parser-js/tree/gh-pages/docs/v2/:path',
text: 'Edit this page on GitHub'
}
},
markdown: {
lineNumbers: true,
// adjust how header anchors are generated,
// useful for integrating with tools that use different conventions
anchors: {
slugify(str) {
return encodeURIComponent(str)
}
}
}
})
Reference in New Issue View Git Blame Copy Permalink