docs: update homepage and styles

This commit is contained in:
braks
2022-08-01 21:10:14 +02:00
committed by Braks
parent 4f036e7672
commit bc87e4718f
13 changed files with 142 additions and 84 deletions
+2 -2
View File
@@ -71,7 +71,7 @@
gap: 5px;
}
.button {
.buttons .button {
background-color: whitesmoke;
cursor: pointer;
padding: 5px 10px;
@@ -82,7 +82,7 @@
box-shadow: 0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1);
}
.button:hover {
.buttons .button:hover {
background: black;
color: white;
}
+1 -1
View File
@@ -4,7 +4,7 @@ import Heart from '~icons/mdi/heart'
<template>
<div id="acknowledgement" class="w-full">
<div class="max-w-11/12 md:max-w-6/12 m-auto py-4 md:(pb-12 pt-6) text-center">
<div class="max-w-[1024px] md:max-w-3/4 m-auto py-4 md:(pb-12 pt-6) text-center">
<div>
<h1 class="md:mb-8 flex justify-center items-center"><Heart class="text-red-500" /> Acknowledgement</h1>
<strong>First off</strong>: A big thank you to the developers of
+19
View File
@@ -0,0 +1,19 @@
<script setup>
import { VPTeamMembers } from 'vitepress/theme'
const members = [
{
avatar: 'https://avatars.githubusercontent.com/u/78412429?v=4',
name: 'Burak Cakmakoglu',
title: 'Creator',
links: [{ icon: 'github', link: 'https://github.com/bcakmakoglu' }],
},
]
</script>
<template>
<div class="w-full flex flex-col gap-4">
<h1 class="md:mb-8 flex justify-center items-center">Meet the Team</h1>
<VPTeamMembers size="small" :members="members" />
</div>
</template>
-39
View File
@@ -1,39 +0,0 @@
// generated by unplugin-vue-components
// We suggest you to commit this file into source control
// Read more: https://github.com/vuejs/core/pull/3399
import '@vue/runtime-core'
declare module '@vue/runtime-core' {
export interface GlobalComponents {
Acknowledgement: typeof import('./../../components/home/Acknowledgement.vue')['default']
Additional: typeof import('./../../components/home/flows/Additional.vue')['default']
App: typeof import('./../../components/examples/basic/App.vue')['default']
Banner: typeof import('./../../components/home/Banner.vue')['default']
Basic: typeof import('./../../components/home/flows/Basic.vue')['default']
Controls: typeof import('./../../components/examples/save-restore/Controls.vue')['default']
Custom: typeof import('./../../components/home/edges/Custom.vue')['default']
CustomConnectionLine: typeof import('./../../components/examples/connectionline/CustomConnectionLine.vue')['default']
CustomEdge: typeof import('./../../components/examples/edges/CustomEdge.vue')['default']
CustomEdge2: typeof import('./../../components/examples/edges/CustomEdge2.vue')['default']
CustomEdgeLabel: typeof import('./../../components/examples/edges/CustomEdgeLabel.vue')['default']
CustomInput: typeof import('./../../components/examples/validation/CustomInput.vue')['default']
CustomNode: typeof import('./../../components/examples/custom-node/CustomNode.vue')['default']
Features: typeof import('./../../components/home/Features.vue')['default']
Flow: typeof import('./../../components/examples/multi/Flow.vue')['default']
Home: typeof import('./../../components/home/Home.vue')['default']
Input: typeof import('./../../components/home/nodes/Input.vue')['default']
InteractionControls: typeof import('./../../components/examples/interaction/InteractionControls.vue')['default']
Intro: typeof import('./../../components/home/flows/Intro.vue')['default']
Nested: typeof import('./../../components/home/flows/Nested.vue')['default']
Output: typeof import('./../../components/home/nodes/Output.vue')['default']
PiniaExample: typeof import('./../../components/examples/pinia/PiniaExample.vue')['default']
Repl: typeof import('./../../components/Repl.vue')['default']
RGB: typeof import('./../../components/home/flows/RGB.vue')['default']
RouterLink: typeof import('vue-router')['RouterLink']
RouterView: typeof import('vue-router')['RouterView']
Sidebar: typeof import('./../../components/examples/dnd/Sidebar.vue')['default']
TeleportableNode: typeof import('./../../components/examples/teleport/TeleportableNode.vue')['default']
}
}
export {}
+44 -8
View File
@@ -58,7 +58,7 @@ export default defineConfigWithTheme<DefaultTheme.Config>({
copyVueFlowPlugin(),
AutoImport({
imports: ['vue', '@vueuse/core'],
dts: resolve(__dirname, './auto-imports.d.ts'),
dts: resolve(__dirname, '../auto-imports.d.ts'),
}),
WindiCSS({
transformCSS: 'pre',
@@ -71,7 +71,7 @@ export default defineConfigWithTheme<DefaultTheme.Config>({
extensions: ['vue', 'md'],
// allow auto import and register components used in markdown
include: [/\.vue$/, /\.vue\?vue/, /\.md$/],
dts: resolve(__dirname, './components.d.ts'),
dts: resolve(__dirname, '../components.d.ts'),
resolvers: [IconsResolver()],
}),
Icons({
@@ -82,15 +82,13 @@ export default defineConfigWithTheme<DefaultTheme.Config>({
themeConfig: {
logo: '/favicons/android-chrome-512x512.png',
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2021-present Burak Cakmakoglu',
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/bcakmakoglu/vue-flow' },
{ icon: 'discord', link: 'https://discord.gg/F4v6qE4Fuq' },
{
icon: {
svg: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>',
},
link: 'https://reactflow.dev/',
},
],
algolia: {
appId: 'F7BJNSM4M5',
@@ -167,6 +165,44 @@ export default defineConfigWithTheme<DefaultTheme.Config>({
],
},
],
'/examples/': [
{
text: 'General Examples',
collapsible: true,
items: [
{ text: 'Basic', link: '/examples/' },
{ text: 'Save & Restore', link: '/examples/save' },
{ text: 'Drag & Drop', link: '/examples/dnd' },
{ text: 'Empty Flow', link: '/examples/empty' },
{ text: 'Hide/Show', link: '/examples/hidden' },
{ text: 'Horizontal Flow', link: '/examples/horizontal' },
{ text: 'Interactions', link: '/examples/interaction' },
{ text: 'Teleport', link: '/examples/teleport' },
{ text: 'Multiple Flows', link: '/examples/multi' },
{ text: 'Pinia', link: '/examples/pinia' },
{ text: 'Stress', link: '/examples/stress' },
],
},
{
text: 'Nodes',
collapsible: true,
items: [
{ text: 'Custom Node', link: '/examples/nodes/' },
{ text: 'Update Node', link: '/examples/nodes/update-node' },
{ text: 'Nested Nodes', link: '/examples/nodes/nesting' },
],
},
{
text: 'Edges',
collapsible: true,
items: [
{ text: 'Edges', link: '/examples/edges/' },
{ text: 'Updatable Edge', link: '/examples/edges/updatable-edge' },
{ text: 'Custom Connectionline', link: '/examples/edges/connection-line' },
{ text: 'Connection validation', link: '/examples/edges/validation' },
],
},
],
},
},
})
@@ -5,11 +5,7 @@ const { Layout: ParentLayout } = DefaultTheme
</script>
<template>
<ParentLayout>
<template #layout-bottom>
<div class="page-footer">MIT Licensed | Copyright © 2021-present Burak Cakmakoglu</div>
</template>
</ParentLayout>
<ParentLayout></ParentLayout>
</template>
<style>
+26 -12
View File
@@ -2,24 +2,38 @@
--primary: #BB86FC;
--secondary: #03dac5;
--vp-c-brand: #10b981;
--vp-c-accent: #BB86FC;
--vp-c-bg-alt: rgb(249, 249, 249, 75%);
}
.dark {
--vp-c-bg: rgba(0, 0, 0, 100%);
--vp-c-bg-alt: rgb(22, 27, 34, 75%);
--vp-c-bg-soft: rgb(22, 27, 34, 100%);
}
.VPNavBar.has-sidebar .content, .VPNav {
background-color: var(--vp-c-bg-alt) !important;
background-image: radial-gradient(transparent 1px, var(--vp-c-bg-alt) 1px) !important;
background-size: 4px 4px !important;
}
.dark .DocSearch {
@apply border shadow bg-zinc-800;
}
.dark .VPNavBarTitle.has-sidebar {
background-color: transparent !important;
}
.VPPage {
@apply px-12 py-6 md:(px-24);
}
html, body {
@apply scrollbar scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-green-500 scrollbar-track-black;
}
.page a {
@apply text-green-500 font-semibold;
}
.examples .page, .examples .page-meta, .footer, .sidebar {
@apply dark:(!bg-black text-white);
}
.examples .page {
--content-width: 100%;
}
h1 {
@apply text-xl lg:text-4xl mb-4 font-bold;
}
+40
View File
@@ -0,0 +1,40 @@
// generated by unplugin-vue-components
// We suggest you to commit this file into source control
// Read more: https://github.com/vuejs/core/pull/3399
import '@vue/runtime-core'
declare module '@vue/runtime-core' {
export interface GlobalComponents {
Acknowledgement: typeof import('./../components/home/Acknowledgement.vue')['default']
Additional: typeof import('./../components/home/flows/Additional.vue')['default']
App: typeof import('./../components/examples/basic/App.vue')['default']
Banner: typeof import('./../components/home/Banner.vue')['default']
Basic: typeof import('./../components/home/flows/Basic.vue')['default']
Controls: typeof import('./../components/examples/save-restore/Controls.vue')['default']
Custom: typeof import('./../components/home/edges/Custom.vue')['default']
CustomConnectionLine: typeof import('./../components/examples/connectionline/CustomConnectionLine.vue')['default']
CustomEdge: typeof import('./../components/examples/edges/CustomEdge.vue')['default']
CustomEdge2: typeof import('./../components/examples/edges/CustomEdge2.vue')['default']
CustomEdgeLabel: typeof import('./../components/examples/edges/CustomEdgeLabel.vue')['default']
CustomInput: typeof import('./../components/examples/validation/CustomInput.vue')['default']
CustomNode: typeof import('./../components/examples/custom-node/CustomNode.vue')['default']
Features: typeof import('./../components/home/Features.vue')['default']
Flow: typeof import('./../components/examples/multi/Flow.vue')['default']
Home: typeof import('./../components/home/Home.vue')['default']
Input: typeof import('./../components/home/nodes/Input.vue')['default']
InteractionControls: typeof import('./../components/examples/interaction/InteractionControls.vue')['default']
Intro: typeof import('./../components/home/flows/Intro.vue')['default']
Nested: typeof import('./../components/home/flows/Nested.vue')['default']
Output: typeof import('./../components/home/nodes/Output.vue')['default']
PiniaExample: typeof import('./../components/examples/pinia/PiniaExample.vue')['default']
Repl: typeof import('./../components/Repl.vue')['default']
RGB: typeof import('./../components/home/flows/RGB.vue')['default']
RouterLink: typeof import('vue-router')['RouterLink']
RouterView: typeof import('vue-router')['RouterView']
Sidebar: typeof import('./../components/examples/dnd/Sidebar.vue')['default']
Team: typeof import('./../components/home/Team.vue')['default']
TeleportableNode: typeof import('./../components/examples/teleport/TeleportableNode.vue')['default']
}
}
export {}
+1 -1
View File
@@ -1,6 +1,6 @@
---
pageClass: examples
layout: page
---
# Basic
+7 -5
View File
@@ -10,10 +10,12 @@ tagline: null
<Banner />
</Suspense>
<client-only>
<Features />
<Features />
<XyzTransition appear-visible xyz="fade down ease-out-back">
<XyzTransition appear-visible xyz="fade down ease-out-back">
<Acknowledgement />
</XyzTransition>
</client-only>
</XyzTransition>
<XyzTransition appear-visible xyz="fade down ease-out-back">
<Team />
</XyzTransition>
+1 -3
View File
@@ -17,7 +17,5 @@
"forceConsistentCasingInFileNames": true,
"types": ["vite/client", "@types/node", "unplugin-icons/types/vue"]
},
"include": ["components", "src", "src/.vuepress"],
"exclude": ["node_modules", "dist"],
"references": [{ "path": "./tsconfig.node.json" }]
"exclude": ["node_modules", "dist"]
}
-8
View File
@@ -1,8 +0,0 @@
{
"compilerOptions": {
"composite": true,
"module": "esnext",
"moduleResolution": "node"
},
"include": ["vite.config.ts"]
}