Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/workflows/vitepress.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Deploy VitePress site to Pages

on:
push:
branches: ["master"]

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "22"
cache: npm
cache-dependency-path: package-lock.json
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: npm ci
- name: Build with VitePress
run: npm run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/.vitepress/dist

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
10 changes: 4 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/node_modules/*
/.temp/*
/docs/.vuepress/dist/*
.DS_Store
*.zip
deploy*
node_modules
/docs/.vitepress/dist
/docs/.vitepress/cache
.directory
41 changes: 41 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { defineConfig } from 'vitepress'
import locales from './locales'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "NexusPHP 文档",
locales: locales.locales,
description: "包含 NexusPHP 的安装、使用、设置、升级、开发等相关知识",
cleanUrls: true,
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
search: {
provider: 'local'
},
nav: [
{ text: 'Blog', link: 'https://nexusphp.org/' },
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/xiaomlove/nexusphp' }
]
},

head: [
[
"script",
{},
`
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?84c0d2679e49f1c63eb79fe1f08b6b11";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
`
],
['meta', { name: 'keywords', content: 'PT, BT, bitbucket, torrent, Private Tracker, Documentation, Doc, 使用文档' }],
['meta', { name: 'keywords', content: 'NexusPHP, Install, Update, Configuration, Development' }]
]
})
30 changes: 30 additions & 0 deletions docs/.vitepress/locales/en.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { defineConfig } from 'vitepress'

export default defineConfig({
lang: 'en-US',

title: 'NexusPHP Documentation',
description: 'Installation, usage, setting, upgrade and development about NexusPHP',
themeConfig: {
nav: nav(),
sidebar: [
{ text: 'Start', link: '/en/start' },
{ text: 'Installation', link: '/en/installation' },
{ text: 'Installation By AAPannel', link: '/en/installation_bt' },
{ text: 'Installation By Docker(>=1.9)', link: '/en/installation_docker' },
{ text: 'Configuration', link: '/en/configuration' },
{ text: 'Upgrade 1.6', link: '/en/update' },
{ text: 'Upgrade 1.7', link: '/en/update1.7' },
{ text: 'Upgrade 1.8', link: '/en/update1.8' },
{ text: 'Upgrade 1.9', link: '/en/update1.9' },
{ text: 'FAQ', link: '/en/faq' },
],
outline: [2, 3],
}
})

function nav() {
return [
{ text: 'Blog', link: 'https://nexusphp.org/' },
]
}
22 changes: 22 additions & 0 deletions docs/.vitepress/locales/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { defineConfig } from 'vitepress'
import en from './en'
import zh from './zh'

export default defineConfig({
locales: {
root: {
lang: 'zh',
label: '中文',
themeConfig: zh.themeConfig,
title: zh.title,
description: zh.description
},
en: {
lang: 'en-US',
label: 'English',
themeConfig: en.themeConfig,
title: en.title,
description: en.description
},
}
})
33 changes: 33 additions & 0 deletions docs/.vitepress/locales/zh.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { defineConfig } from 'vitepress'

export default defineConfig({
lang: 'zh',
title: 'NexusPHP 文档',
description: '包含 NexusPHP 的安装、使用、设置、升级、开发等相关知识',

themeConfig: {
nav: nav(),
sidebar: [
{ text: '起步', link: '/start' },
{ text: '手动安装', link: '/installation' },
{ text: '宝塔面板安装', link: '/installation_bt' },
{ text: '1Panel 安装', link: '/installation_1panel' },
{ text: 'Docker 安装(>=1.9)', link: '/installation_docker' },
{ text: '设置', link: '/configuration' },
{ text: 'Go Tracker', link: '/go_tracker' },
{ text: 'ClickHouse', link: '/clickhouse' },
{ text: '升级1.6', link: '/update' },
{ text: '升级1.7', link: '/update1.7' },
{ text: '升级1.8', link: '/update1.8' },
{ text: '升级1.9', link: '/update1.9' },
{ text: '常见问题', link: '/faq' },
],
outline: [2, 3],
}
})

function nav() {
return [
{ text: '博客', link: 'https://nexusphp.org/' },
]
}
17 changes: 17 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import './style.css'

export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
},
enhanceApp({ app, router, siteData }) {
// ...
}
} satisfies Theme
139 changes: 139 additions & 0 deletions docs/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/**
* Customize default theme styling by overriding CSS variables:
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
*/

/**
* Colors
*
* Each colors have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
* - `XXX-3`: The color for solid background, such as bg color of the button.
* It must satisfy the contrast ratio with pure white (#ffffff) text on
* top of it.
*
* - `XXX-soft`: The color used for subtle background such as custom container
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
* on top of it.
*
* The soft color must be semi transparent alpha channel. This is crucial
* because it allows adding multiple "soft" colors on top of each other
* to create a accent, such as when having inline code block inside
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attached to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
*
* - `tip`: Used to indicate useful information. The default theme uses the
* brand color for this by default.
*
* - `warning`: Used to indicate warning to the users. Used in custom
* container, badges, etc.
*
* - `danger`: Used to show error, or dangerous message to the users. Used
* in custom container, badges, etc.
* -------------------------------------------------------------------------- */

:root {
--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);

--vp-c-brand-1: var(--vp-c-green-1);
--vp-c-brand-2: var(--vp-c-green-2);
--vp-c-brand-3: var(--vp-c-green-3);
--vp-c-brand-soft: var(--vp-c-green-soft);

--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
--vp-c-tip-3: var(--vp-c-brand-3);
--vp-c-tip-soft: var(--vp-c-brand-soft);

--vp-c-warning-1: var(--vp-c-yellow-1);
--vp-c-warning-2: var(--vp-c-yellow-2);
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);

--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
}

/**
* Component: Button
* -------------------------------------------------------------------------- */

:root {
--vp-button-brand-border: transparent;
--vp-button-brand-text: var(--vp-c-white);
--vp-button-brand-bg: var(--vp-c-brand-3);
--vp-button-brand-hover-border: transparent;
--vp-button-brand-hover-text: var(--vp-c-white);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-border: transparent;
--vp-button-brand-active-text: var(--vp-c-white);
--vp-button-brand-active-bg: var(--vp-c-brand-1);
}

/**
* Component: Home
* -------------------------------------------------------------------------- */

:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#3eaf7c 30%,
#41d1ff
);

--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#3eaf7c 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}

@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}

@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}

/**
* Component: Custom Block
* -------------------------------------------------------------------------- */

:root {
--vp-custom-block-tip-border: transparent;
--vp-custom-block-tip-text: var(--vp-c-text-1);
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
}

/**
* Component: Algolia
* -------------------------------------------------------------------------- */

.DocSearch {
--docsearch-primary-color: var(--vp-c-brand-1) !important;
}

8 changes: 0 additions & 8 deletions docs/.vuepress/components/ArticleTopAd.vue

This file was deleted.

10 changes: 0 additions & 10 deletions docs/.vuepress/components/SocialAccount.vue

This file was deleted.

Loading