Skip to content

Commit 2b5063b

Browse files
committed
feat(docs): update vuepress documentation site and fix issues with links
1 parent 6c84b4c commit 2b5063b

File tree

24 files changed

+1171
-4231
lines changed

24 files changed

+1171
-4231
lines changed

backend/backend/settings/raspberrypi.py

Lines changed: 0 additions & 42 deletions
This file was deleted.

stack.yml

Lines changed: 0 additions & 173 deletions
This file was deleted.

vuepress-docs/docs/.vuepress/config.ts

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
import { defineUserConfig } from 'vuepress'
2-
import type { DefaultThemeOptions } from 'vuepress'
2+
import { viteBundler } from '@vuepress/bundler-vite'
3+
import { searchPlugin } from '@vuepress/plugin-search'
34
import { navbar } from './configs';
5+
import { defaultTheme } from '@vuepress/theme-default';
46

5-
export default defineUserConfig<DefaultThemeOptions>({
7+
export default defineUserConfig({
8+
bundler: viteBundler(),
69
port: 8089,
710
base: '/django-step-by-step/',
811
head: [
@@ -19,15 +22,7 @@ export default defineUserConfig<DefaultThemeOptions>({
1922
],
2023
],
2124
plugins: [
22-
[
23-
'@vuepress/pwa',
24-
{
25-
skipWaiting: true,
26-
},
27-
],
28-
[
29-
'@vuepress/plugin-search',
30-
{
25+
searchPlugin({
3126
locales: {
3227
'/': {
3328
placeholder: 'Search',
@@ -36,11 +31,10 @@ export default defineUserConfig<DefaultThemeOptions>({
3631
placeholder: '搜索',
3732
},
3833
},
39-
},
40-
],
34+
})
4135
],
42-
// site-level locales config
4336

37+
// site-level locales config
4438
locales: {
4539
'/': {
4640
lang: 'en-US',
@@ -54,9 +48,10 @@ export default defineUserConfig<DefaultThemeOptions>({
5448
},
5549
},
5650

57-
themeConfig: {
51+
theme: defaultTheme({
52+
5853
logo: '/images/ublog.png',
59-
darkMode: true,
54+
// darkMode: true,
6055
repo: 'https://github.com/briancaffey/django-step-by-step',
6156

6257
docsDir: 'vuepress-docs/docs',
@@ -107,10 +102,10 @@ export default defineUserConfig<DefaultThemeOptions>({
107102

108103
// a11y
109104
openInNewWindow: '在新窗口打开',
110-
toggleDarkMode: '切换夜间模式',
105+
// toggleDarkMode: '切换夜间模式',
111106
},
112107
},
113-
},
108+
}),
114109
lang: 'en-US',
115110
title: 'Django Step by Step Documentation',
116111
description: 'Documentation for Django Step by Step',

vuepress-docs/docs/.vuepress/configs/navbar/en.ts

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,44 +11,24 @@ export const en: NavbarConfig = [
1111
children: [
1212
{
1313
text: 'Django Application',
14-
link: '/topics/django/',
14+
link: '/topics/django',
1515
},
1616
{
1717
text: 'Nuxt Application',
18-
link: '/topics/nuxt/',
18+
link: '/topics/nuxt',
1919
},
2020
{
2121
text: 'Docker Compose',
22-
link: '/topics/docker-compose/',
22+
link: '/topics/docker-compose',
2323
},
2424
{
2525
text: 'VuePress Documentation',
26-
link: '/topics/vuepress/',
27-
}
28-
],
29-
},
30-
{
31-
text: 'Guide',
32-
link: '/guide/',
33-
children: [
34-
{
35-
text: 'Step by step guide',
36-
link: '/guide/step-by-step/',
37-
},
38-
{
39-
text: 'CI/CD',
40-
children: [
41-
{
42-
text: 'GitHub Actions',
43-
link: '/guide/ci-cd/github-actions/',
44-
}
45-
]
26+
link: '/topics/vuepress',
4627
}
4728
],
4829
},
4930
{
5031
text: 'Deploy',
51-
// link: '/deploy/',
5232
children: [
5333
{
5434
link: '/deploy/aws',
@@ -70,10 +50,10 @@ export const en: NavbarConfig = [
7050
},
7151
{
7252
text: 'Application Updates',
73-
// link: '/deploy/app'
53+
link: '/deploy/app',
7454
children: [
7555
{
76-
link: '/deploy/app',
56+
link: '/deploy/github-actions',
7757
text: 'GitHub Action'
7858
}
7959
]

vuepress-docs/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ home: true
33

44
actions:
55
- text: Introduction
6-
link: /intro
6+
link: /intro/
77
type: primary
88
heroImage: /images/ublog.png
99

File renamed without changes.

vuepress-docs/docs/deploy/aws/README.md renamed to vuepress-docs/docs/deploy/aws.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
---
2-
next: /deploy/aws/cdk
2+
next: /deploy/aws/terraform
33
prev: /guide/ci-cd/github-actions
44

55
head:
66
- - meta
77
- name: description
88
content: Using different Infrastructure as Code tools for deploying Django projects
9-
# - - link
10-
# - rel: canonical
11-
# href: https://briancaffey.github.io/
129
---
1310

1411
# Overview of options for deploying μblog
File renamed without changes.

0 commit comments

Comments
 (0)