Skip to content

Commit 6301a77

Browse files
authored
Fix/docs 1 (#170)
* fix: add guide link to footer component * fix: add .vitepress/dist and .vitepress/cache to .gitignore * fix: update navigation link from 'Examples' to 'Demo' in VitePress config * fix: add .vitepress/.temp to .gitignore * fix: update documentation with installation, integration, and usage details; remove outdated examples * fix: update navigation links and add demo documentation; remove demo section from quick-start * fix: enhance documentation with new sections for About, Language Support, Automatic Draft Recovery, and Providing Configuration; update navigation links * fix: update documentation with new sections for Information, Rendering HTML Output, and Retrieving HTML for Submission; enhance navigation links * fix: update navigation links for Getting Started; add new documentation for restoring previously saved content * fix: add new documentation sections for Publish Changes and Use in Modal; update navigation links * fix: add new documentation sections for Styling and Troubleshooting; update navigation links * fix: add Guide section to documentation; update navigation links * Remove outdated documentation and add new guides for custom HTML builder elements and media library integration * fix: update site title and tagline; add favicon and improve head configuration * fix: remove Google Fonts import for Jost and streamline font family declaration * fix: update version to 3.4.88 in package.json
1 parent 3088536 commit 6301a77

29 files changed

+888
-938
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,8 @@ LOCAL_DEVELOPMENT.md
2929
/public/css/app.css
3030
/public/js/app.js
3131
new_release/
32-
/missing-translations.txt
32+
/missing-translations.txt
33+
34+
.vitepress/dist
35+
.vitepress/cache
36+
.vitepress/.temp

.vitepress/cache/deps/_metadata.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
{
2-
"hash": "93f62d33",
2+
"hash": "a9ff6cd6",
33
"configHash": "3479b32c",
4-
"lockfileHash": "7c5f4818",
5-
"browserHash": "47c4f132",
4+
"lockfileHash": "8b6788ae",
5+
"browserHash": "5a798d95",
66
"optimized": {
77
"vue": {
88
"src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "4c54357b",
10+
"fileHash": "f9ad5954",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../node_modules/vitepress/node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "0c7c45e8",
16+
"fileHash": "82315b95",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../node_modules/@vueuse/core/dist/index.js",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "ccc1e8c5",
22+
"fileHash": "77af0a9c",
2323
"needsInterop": false
2424
},
2525
"vitepress > @vueuse/integrations/useFocusTrap": {
2626
"src": "../../../node_modules/@vueuse/integrations/dist/useFocusTrap.js",
2727
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28-
"fileHash": "bee44db6",
28+
"fileHash": "a3df1882",
2929
"needsInterop": false
3030
},
3131
"vitepress > mark.js/src/vanilla.js": {
3232
"src": "../../../node_modules/mark.js/src/vanilla.js",
3333
"file": "vitepress___mark__js_src_vanilla__js.js",
34-
"fileHash": "8d877008",
34+
"fileHash": "5246dccf",
3535
"needsInterop": false
3636
},
3737
"vitepress > minisearch": {
3838
"src": "../../../node_modules/minisearch/dist/es/index.js",
3939
"file": "vitepress___minisearch.js",
40-
"fileHash": "76b40397",
40+
"fileHash": "3d02d0f8",
4141
"needsInterop": false
4242
}
4343
},

.vitepress/config.ts

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@ import { defineConfig } from 'vitepress'
33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
55
srcDir: 'docs',
6-
7-
title: 'Vue 3 Page Builder',
6+
title: 'Vue 3 Page Builder Guide',
87
description:
98
'Vue 3 Drag & Drop Page Builder. Power your vision and build impressive, modern pages. A web builder designed for stunning results. Enable users to design and publish responsive pages—such as listings, job posts, or blogs—at any scale. Easily manage and update content with flexibility.',
109
base: '/vue-website-page-builder/',
10+
head: [
11+
['link', { rel: 'icon', href: '/vue-website-page-builder/favicon.ico' }],
12+
['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
13+
['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }],
14+
[
15+
'link',
16+
{
17+
href: 'https://fonts.googleapis.com/css2?family=Jost:ital,wght@0,100..900;1,100..900&display=swap',
18+
rel: 'stylesheet',
19+
},
20+
],
21+
],
1122
themeConfig: {
1223
search: {
1324
provider: 'local',
@@ -16,20 +27,41 @@ export default defineConfig({
1627
// https://vitepress.dev/reference/default-theme-config
1728
nav: [
1829
{ text: 'Home', link: '/' },
19-
{ text: 'Examples', link: '/markdown-examples' },
30+
{ text: 'Getting Started', link: '/getting-started' },
31+
{ text: 'Demo', link: 'https://mybuilder.dev' },
2032
],
2133

2234
sidebar: [
2335
{
2436
text: 'Guide',
2537
items: [
26-
{ text: 'Markdown Examples', link: '/markdown-examples' },
27-
{ text: 'Runtime API Examples', link: '/api-examples' },
38+
{ text: 'Demo', link: '/demo' },
39+
{ text: 'Information', link: '/information' },
40+
{ text: 'Getting Started', link: '/getting-started' },
41+
{ text: 'Installation', link: '/installation' },
42+
{ text: 'Nuxt Integration', link: '/nuxt-integration' },
43+
{ text: 'Vue Integration', link: '/vue-integration' },
44+
{ text: 'Providing Configuration', link: '/providing-configuration' },
45+
{ text: 'Language Support', link: '/language-support' },
46+
{ text: 'Automatic Draft Recovery', link: '/automatic-draft-recovery' },
47+
{ text: 'Retrieving HTML for Submission', link: '/retrieving-html-for-submission' },
48+
{ text: 'Restoring Previously Content', link: '/restoring-previously-content' },
49+
{ text: 'Rendering HTML Output', link: '/rendering-html-output' },
50+
{ text: 'Publish Changes', link: '/publish-changes' },
51+
{ text: 'Use in Modal', link: '/use-in-modal' },
52+
{ text: 'Styling', link: '/styling' },
53+
{ text: 'Custom Media Library', link: '/custom-media-library' },
54+
{ text: 'Unsplash Integration', link: '/unsplash' },
55+
{ text: 'Custom HTML Builder Elements', link: '/custom-html-builder-elements' },
56+
{ text: 'Troubleshooting', link: '/troubleshooting' },
2857
],
2958
},
3059
],
3160
socialLinks: [
3261
{ icon: 'github', link: 'https://github.com/myissue-studio/vue-website-page-builder' },
3362
],
63+
footer: {
64+
message: 'Released under the MIT License.',
65+
},
3466
},
3567
})

0 commit comments

Comments
 (0)