From f7e6ec345fcaf113a6c38a6436a4135749f69edc Mon Sep 17 00:00:00 2001 From: fratzinger <22286818+fratzinger@users.noreply.github.com> Date: Thu, 22 Sep 2022 09:54:36 +0200 Subject: [PATCH] docs: fix heading levels (#186) * docs: update heading levels * docs: update dependency * docs: add head meta --- docs/.vitepress/config.ts | 48 +- docs/.vitepress/meta.ts | 5 + docs/.vitepress/theme/Layout.vue | 1 - docs/.vitepress/theme/custom.css | 13 + docs/best-practices.md | 2 +- docs/configuration.md | 6 +- docs/getting-started.md | 6 +- docs/index.md | 3 +- docs/migration.md | 26 +- docs/overview.md | 12 +- docs/process-flows.md | 6 +- docs/service-calls.md | 32 +- docs/service-hooks.md | 12 +- package-lock.json | 6822 ++++++++++++++---------------- package.json | 4 +- tsconfig.json | 2 +- 16 files changed, 3258 insertions(+), 3742 deletions(-) create mode 100644 docs/.vitepress/meta.ts diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index fe0713f..934a399 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,10 +1,23 @@ import { defineConfig } from 'vitepress' +import { version } from '../../package.json' +import { description, name, ogImage, ogUrl } from './meta'; export default defineConfig({ title: "feathers-auth-mgmt", description: "Sign up verification, forgotten password reset, and other capabilities for local authentication", - head: [['link', { rel: 'icon', href: '/favicon.ico' }]], + head: [ + ['link', { rel: 'icon', href: '/favicon.ico' }], + ["meta", { name: "theme-color", content: "#64007a" }], + ["meta", { property: "og:title", content: name }], + ["meta", { property: "og:description", content: description }], + ["meta", { property: "og:url", content: ogUrl }], + ["meta", { property: "og:image", content: ogImage }], + ["meta", { name: "twitter:title", content: name }], + ["meta", { name: "twitter:description", content: description }], + ["meta", { name: "twitter:image", content: ogImage }], + ["meta", { name: "twitter:card", content: "summary_large_image" }], + ], themeConfig: { logo: '/logo.svg', editLink: { @@ -12,8 +25,18 @@ export default defineConfig({ text: 'Edit this page on GitHub' }, socialLinks: [ - { icon: 'github', link: 'https://github.com/feathersjs-ecosystem/feathers-authentication-management' }, - { icon: 'discord', link: 'https://discord.gg/C6rSjSWR' } + { + icon: "twitter", + link: "https://twitter.com/feathersjs", + }, + { + icon: "discord", + link: "https://discord.gg/qa8kez8QBx", + }, + { + icon: "github", + link: "https://github.com/feathersjs-ecosystem/feathers-authentication-management", + }, ], footer: { message: 'Released under the MIT License.', @@ -53,13 +76,18 @@ export default defineConfig({ ], nav: [ { - text: 'Config', - link: '/configuration' - }, - { - text: 'Changelog', - link: 'https://github.com/feathersjs-ecosystem/feathers-authentication-management/blob/master/CHANGELOG.md' + text: `v${version}`, + items: [ + { + text: 'Changelog', + link: 'https://github.com/feathersjs-ecosystem/feathers-authentication-management/blob/master/CHANGELOG.md' + }, + { + text: 'Contributing', + link: 'https://github.com/feathersjs-ecosystem/feathers-authentication-management/blob/master/.github/contributing.md' + } + ] } - ] + ], } }); diff --git a/docs/.vitepress/meta.ts b/docs/.vitepress/meta.ts new file mode 100644 index 0000000..ff83fb8 --- /dev/null +++ b/docs/.vitepress/meta.ts @@ -0,0 +1,5 @@ +export const name = "feathers-authentication-management"; +export const description = "Adds sign up verification, forgotten password reset, and other capabilities to local feathers-authentication"; + +export const ogUrl = "https://feathers-a-m.netlify.app/"; +export const ogImage = "https://feathers-a-m.netlify.app/logo.png"; diff --git a/docs/.vitepress/theme/Layout.vue b/docs/.vitepress/theme/Layout.vue index 551b6bd..23018ea 100644 --- a/docs/.vitepress/theme/Layout.vue +++ b/docs/.vitepress/theme/Layout.vue @@ -1,4 +1,3 @@ -