Skip to content

Commit 2a59ace

Browse files
committed
feat: migrate to vitepress
1 parent d696f34 commit 2a59ace

10 files changed

Lines changed: 1315 additions & 11488 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
.DS_Store
2-
32
node_modules
43
.idea
5-
6-
lib/core/metadata.js
7-
lib/core/MetadataBlog.js
8-
9-
website/translated_docs
10-
website/build/
11-
website/yarn.lock
12-
website/node_modules
13-
website/i18n/*
4+
.vitepress/cache
5+
.vitepress/dist

‎.vitepress/config.ts‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import {defineConfig} from 'vitepress';
2+
3+
export default defineConfig({
4+
lang: 'en-US',
5+
title: 'Gotify',
6+
description: 'a simple server for sending and receiving messages',
7+
sitemap: {hostname: 'https://gotify.net'},
8+
9+
cleanUrls: true,
10+
lastUpdated: true,
11+
srcExclude: ['README.md'],
12+
13+
head: [['link', {rel: 'icon', type: 'image/png', href: '/img/favicon.png'}]],
14+
15+
themeConfig: {
16+
logo: '/img/logo.png',
17+
externalLinkIcon: true,
18+
search: {provider: 'local'},
19+
nav: [
20+
{text: 'Docs', link: '/docs/'},
21+
{text: 'API-Docs', link: '/api-docs'},
22+
],
23+
sidebar: {
24+
'/docs/': [
25+
{
26+
text: 'Getting Started',
27+
items: [
28+
{text: 'Intro', link: '/docs/'},
29+
{text: 'Installation', link: '/docs/install'},
30+
{text: 'Configuration', link: '/docs/config'},
31+
{text: 'First Login', link: '/docs/first-login'},
32+
{text: 'Push messages', link: '/docs/pushmsg'},
33+
{text: 'Message Extras', link: '/docs/msgextras'},
34+
],
35+
},
36+
{
37+
text: 'REST-API',
38+
items: [{text: 'Swagger Documentation', link: '/docs/swagger-docs'}],
39+
},
40+
{
41+
text: 'Plugins',
42+
items: [
43+
{text: 'Intro to Gotify Plugins', link: '/docs/plugin'},
44+
{text: 'Writing Plugins', link: '/docs/plugin-write'},
45+
{text: 'Building and Deploying Plugins', link: '/docs/plugin-deploy'},
46+
],
47+
},
48+
{
49+
text: 'Development',
50+
items: [
51+
{text: 'Setup Environment', link: '/docs/dev-setup'},
52+
{text: 'Servers and Tests', link: '/docs/dev-server-and-tests'},
53+
{text: 'Build Gotify', link: '/docs/build'},
54+
],
55+
},
56+
{
57+
text: 'Miscellaneous',
58+
items: [
59+
{text: 'Apache reverse proxy', link: '/docs/apache'},
60+
{text: 'Caddy 2 reverse proxy', link: '/docs/caddy'},
61+
{text: 'Haproxy reverse proxy', link: '/docs/haproxy'},
62+
{text: '(more) Push message examples', link: '/docs/more-pushmsg'},
63+
{text: 'nginx reverse proxy', link: '/docs/nginx'},
64+
{text: 'Optimize uploaded images', link: '/docs/optimize-images'},
65+
{text: 'systemd configuration', link: '/docs/systemd'},
66+
{text: 'Traefik reverse proxy', link: '/docs/traefik'},
67+
],
68+
},
69+
],
70+
},
71+
72+
editLink: {
73+
pattern: 'https://github.com/gotify/website/tree/master/:path',
74+
text: 'Edit this page on GitHub',
75+
},
76+
77+
socialLinks: [{icon: 'github', link: 'https://github.com/gotify'}],
78+
},
79+
});

‎package.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "gotify-website",
3+
"private": true,
4+
"type": "module",
5+
"scripts": {
6+
"dev": "vitepress dev",
7+
"build": "vitepress build",
8+
"preview": "vitepress preview",
9+
"format": "prettier docs/**/*.md .vitepress/**/*.{ts,vue,css} *.md --write",
10+
"format:test": "prettier docs/**/*.md .vitepress/**/*.{ts,vue,css} *.md --list-different"
11+
},
12+
"dependencies": {
13+
"vitepress": "^1.6.0",
14+
"prettier": "^3.3.3"
15+
}
16+
}

‎website/.prettierignore‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎website/core/Footer.js‎

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

0 commit comments

Comments
 (0)