Skip to content

Commit 4028120

Browse files
jc21jc21
authored
Merge pull request #3395 from tilalx/develop
upgrade docs to vuepress v2.0.0-rc and implement dark mode
2 parents 883a272 + d1119ec commit 4028120

File tree

12 files changed

+4636
-11510
lines changed

12 files changed

+4636
-11510
lines changed

‎Jenkinsfile

+15
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,21 @@ pipeline {
141141
junit 'test/results-sqlite/junit/*'
142142
}
143143
}
144+
junit 'test/results/junit/*'
145+
}
146+
}
147+
}
148+
stage('Docs') {
149+
when {
150+
not {
151+
equals expected: 'UNSTABLE', actual: currentBuild.result
152+
}
153+
}
154+
steps {
155+
dir(path: 'docs') {
156+
sh 'yarn set version berry'
157+
sh 'yarn install'
158+
sh 'yarn build'
144159
}
145160
stage('Mysql') {
146161
steps {

‎docs/.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
.vuepress/dist
22
node_modules
33
ts
4+
.temp
5+
.cache
6+
7+
.yarn/*
8+
!.yarn/releases
9+
!.yarn/plugins
10+
!.yarn/sdks
11+
!.yarn/versions
12+
*.gz
13+
*.tgz

‎docs/.vuepress/config.js

+111-82
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,111 @@
1-
module.exports = {
2-
locales: {
3-
"/": {
4-
lang: "en-US",
5-
title: "Nginx Proxy Manager",
6-
description: "Expose your services easily and securely"
7-
}
8-
},
9-
head: [
10-
["link", { rel: "icon", href: "/icon.png" }],
11-
["meta", { name: "description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt" }],
12-
["meta", { property: "og:title", content: "Nginx Proxy Manager" }],
13-
["meta", { property: "og:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
14-
["meta", { property: "og:type", content: "website" }],
15-
["meta", { property: "og:url", content: "https://nginxproxymanager.com/" }],
16-
["meta", { property: "og:image", content: "https://nginxproxymanager.com/icon.png" }],
17-
["meta", { name: "twitter:card", content: "summary"}],
18-
["meta", { name: "twitter:title", content: "Nginx Proxy Manager"}],
19-
["meta", { name: "twitter:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
20-
["meta", { name: "twitter:image", content: "https://nginxproxymanager.com/icon.png"}],
21-
["meta", { name: "twitter:alt", content: "Nginx Proxy Manager"}],
22-
],
23-
themeConfig: {
24-
logo: "/icon.png",
25-
// the GitHub repo path
26-
repo: "jc21/nginx-proxy-manager",
27-
// the label linking to the repo
28-
repoLabel: "GitHub",
29-
// if your docs are not at the root of the repo:
30-
docsDir: "docs",
31-
// defaults to false, set to true to enable
32-
editLinks: true,
33-
locales: {
34-
"/": {
35-
// text for the language dropdown
36-
selectText: "Languages",
37-
// label for this locale in the language dropdown
38-
label: "English",
39-
// Custom text for edit link. Defaults to "Edit this page"
40-
editLinkText: "Edit this page on GitHub",
41-
// Custom navbar values
42-
nav: [{ text: "Setup", link: "/setup/" }],
43-
// Custom sidebar values
44-
sidebar: [
45-
"/",
46-
["/guide/", "Guide"],
47-
["/screenshots/", "Screenshots"],
48-
["/setup/", "Setup Instructions"],
49-
["/advanced-config/", "Advanced Configuration"],
50-
["/upgrading/", "Upgrading"],
51-
["/faq/", "Frequently Asked Questions"],
52-
["/third-party/", "Third Party"]
53-
]
54-
}
55-
}
56-
},
57-
plugins: [
58-
[
59-
"@vuepress/google-analytics",
60-
{
61-
ga: "UA-99675467-4"
62-
}
63-
],
64-
[
65-
"sitemap",
66-
{
67-
hostname: "https://nginxproxymanager.com"
68-
}
69-
],
70-
[
71-
'vuepress-plugin-zooming',
72-
{
73-
selector: '.zooming',
74-
delay: 1000,
75-
options: {
76-
bgColor: 'black',
77-
zIndex: 10000,
78-
},
79-
},
80-
],
81-
]
82-
};
1+
import { defineUserConfig } from 'vuepress';
2+
import { defaultTheme } from 'vuepress'
3+
import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics';
4+
import { searchPlugin } from '@vuepress/plugin-search'
5+
import { sitemapPlugin } from 'vuepress-plugin-sitemap2';
6+
import zoomingPlugin from 'vuepress-plugin-zooming';
7+
8+
export default defineUserConfig({
9+
locales: {
10+
"/": {
11+
lang: "en-US",
12+
title: "Nginx Proxy Manager",
13+
description: "Expose your services easily and securely",
14+
},
15+
},
16+
head: [
17+
["link", { rel: "icon", href: "/icon.png" }],
18+
["meta", { name: "description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt" }],
19+
["meta", { property: "og:title", content: "Nginx Proxy Manager" }],
20+
["meta", { property: "og:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
21+
["meta", { property: "og:type", content: "website" }],
22+
["meta", { property: "og:url", content: "https://nginxproxymanager.com/" }],
23+
["meta", { property: "og:image", content: "https://nginxproxymanager.com/icon.png" }],
24+
["meta", { name: "twitter:card", content: "summary"}],
25+
["meta", { name: "twitter:title", content: "Nginx Proxy Manager"}],
26+
["meta", { name: "twitter:description", content: "Docker container and built in Web Application for managing Nginx proxy hosts with a simple, powerful interface, providing free SSL support via Let's Encrypt"}],
27+
["meta", { name: "twitter:image", content: "https://nginxproxymanager.com/icon.png"}],
28+
["meta", { name: "twitter:alt", content: "Nginx Proxy Manager"}],
29+
],
30+
theme: defaultTheme({
31+
logo: '/icon.png',
32+
repo: "jc21/nginx-proxy-manager",
33+
docsRepo: 'https://github.com/jc21/nginx-proxy-manager',
34+
docsBranch: 'develop',
35+
docsDir: 'docs',
36+
editLinkPattern: ':repo/edit/:branch/:path',
37+
locales: {
38+
'/': {
39+
label: 'English',
40+
selectLanguageText: 'Languages',
41+
selectLanguageName: 'English',
42+
editLinkText: 'Edit this page on GitHub',
43+
navbar: [
44+
{ text: 'Setup', link: '/setup/' }
45+
],
46+
sidebar: {
47+
'/': [
48+
{
49+
text: 'Guide',
50+
children: ['/guide/README.md'],
51+
collapsible: true,
52+
},
53+
{
54+
text: 'Screenshots',
55+
children: ['/screenshots/README.md'],
56+
collapsible: true,
57+
},
58+
{
59+
text: 'Setup',
60+
children: ['/setup/README.md'],
61+
collapsible: true,
62+
},
63+
{
64+
text: 'Advanced Configuration',
65+
children: ['/advanced-config/README.md'],
66+
collapsible: true,
67+
},
68+
{
69+
text: 'Upgrading',
70+
children: ['/upgrading/README.md'],
71+
collapsible: true,
72+
},
73+
{
74+
text: 'Frequently Asked Questions',
75+
children: ['/faq/README.md'],
76+
collapsible: true,
77+
},
78+
{
79+
text: 'Third Party',
80+
children: ['/third-party/README.md'],
81+
collapsible: true,
82+
},
83+
],
84+
},
85+
}
86+
}
87+
}),
88+
plugins: [
89+
googleAnalyticsPlugin({
90+
id: 'UA-99675467-4'
91+
}),
92+
sitemapPlugin({
93+
hostname: "https://nginxproxymanager.com",
94+
}),
95+
zoomingPlugin({
96+
selector: '.zooming',
97+
delay: 1000,
98+
options: {
99+
bgColor: 'black',
100+
zIndex: 10000,
101+
},
102+
}),
103+
searchPlugin({
104+
locales: {
105+
'/': {
106+
placeholder: 'Search',
107+
},
108+
},
109+
}),
110+
],
111+
});

0 commit comments

Comments
 (0)