Initial commit

docs-source/src/.vuepress/config.ts

@@ -0,0 +1,64 @@
+import { defaultTheme } from 'vuepress';
+import { shikiPlugin } from '@vuepress/plugin-shiki';
+import { searchPlugin } from '@vuepress/plugin-search';
+import { navBarItems, sideBarItems, configs, pageLinkRefs } from './configs/template';
+import { env, markdown } from './configs/utils';
+
+export default {
+    dest: configs.dev.dest,
+    port: configs.dev.port,
+    base: configs.website.base,
+    head: [['link', { rel: 'icon', href: configs.website.icon }]],
+    title: configs.website.title,
+    description: configs.website.locales['/en/'].description,
+    locales: configs.website.locales,
+    theme: defaultTheme({
+        logo: configs.website.logo,
+        repo: configs.github.repo,
+        docsRepo: configs.github.repo,
+        docsBranch: configs.github.branch,
+        docsDir: configs.github.dir,
+        editLinkPattern: ':repo/edit/:branch/:path',
+        sidebar: sideBarItems,
+        sidebarDepth: 2,
+        locales: {
+            '/en/': {
+                navbar: navBarItems['/en/'],
+                selectLanguageText: 'English (US)',
+                selectLanguageName: 'English',
+                editLinkText: 'Edit this page on GitHub',
+                tip: 'Tips',
+                warning: 'Notice',
+                danger: 'Pay Attention',
+            },
+            '/zh-cn/': {
+                navbar: navBarItems['/zh-cn/'],
+                selectLanguageText: '简体中文 (CN)',
+                selectLanguageName: '简体中文',
+                editLinkText: '在 GitHub 上编辑此页',
+                notFound: ['这里什么都没有', '我们怎么到这来了？', '这是一个 404 页面', '看起来我们进入了错误的链接'],
+                backToHome: '回到首页',
+                contributorsText: '贡献者',
+                lastUpdatedText: '上次更新',
+                tip: '小提示',
+                warning: '注意',
+                danger: '特别注意',
+                openInNewWindow: '在新窗口中打开',
+                toggleColorMode: '切换颜色模式'
+            }
+        },
+    }),
+    extendsMarkdown: (md: markdownit) => {
+        markdown.injectLinks(md, env.dev ? pageLinkRefs.dev : pageLinkRefs.prod);
+    },
+    plugins: [
+        shikiPlugin({ theme: 'github-dark-dimmed' }),
+        searchPlugin({
+            isSearchable: (page) => page.path !== '/',
+            locales: {
+                '/en/': { placeholder: 'Search' },
+                '/zh-cn/': { placeholder: '搜索' }
+            }
+        })
+    ]
+};

docs-source/src/.vuepress/configs/template.ts

@@ -0,0 +1,146 @@
+import { i18n } from './utils';
+
+interface PageLinkRefs {
+    dev: Record<string, string>[];
+    prod: Record<string, string>[];
+}
+
+const navigationLinks = {
+    start: [
+        '/guide/home',
+        '/guide/quick-start'
+    ],
+    library: [
+        '/library/android',
+        '/library/compose'
+    ],
+    config: [
+        '/config/r8-proguard'
+    ],
+    about: [
+        '/about/changelog',
+        '/about/future',
+        '/about/contacts',
+        '/about/about'
+    ]
+};
+
+export const configs = {
+    dev: {
+        dest: 'dist',
+        port: 9000
+    },
+    website: {
+        base: '/PanguText/',
+        icon: '/images/logo.png',
+        logo: '/images/logo.png',
+        title: 'Pangu Text',
+        locales: {
+            '/en/': {
+                lang: 'en-US',
+                description: 'A typographic solution for the optimal alignment of CJK characters, English words, and half-width digits'
+            },
+            '/zh-cn/': {
+                lang: 'zh-CN',
+                description: '一个中日韩 (CJK) 与英文单词、半角数字排版的解决方案'
+            }
+        }
+    },
+    github: {
+        repo: 'https://github.com/BetterAndroid/PanguText',
+        page: 'https://betterandroid.github.io/PanguText',
+        branch: 'main',
+        dir: 'docs-source/src'
+    }
+};
+
+export const pageLinkRefs: PageLinkRefs = {
+    dev: [
+        { 'repo://': `${configs.github.repo}/` },
+        // KDoc URL for local debugging, non-fixed value, adjust according to your own needs.
+        // You can run ./build-dokka.sh and start the local server in dist/KDoc.
+        { 'kdoc://': 'http://localhost:9001/' }
+    ],
+    prod: [
+        { 'repo://': `${configs.github.repo}/` },
+        { 'kdoc://': `${configs.github.page}/KDoc/` }
+    ]
+};
+
+export const navBarItems = {
+    '/en/': [{
+        text: 'Navigation',
+        children: [{
+            text: 'Get Started',
+            children: i18n.array(navigationLinks.start, 'en')
+        }, {
+            text: 'Libraries',
+            children: i18n.array(navigationLinks.library, 'en')
+        }, {
+            text: 'Configs',
+            children: i18n.array(navigationLinks.config, 'en')
+        }, {
+            text: 'About',
+            children: i18n.array(navigationLinks.about, 'en')
+        }]
+    }, {
+        text: 'Contact Us',
+        link: i18n.string(navigationLinks.about[2], 'en')
+    }],
+    '/zh-cn/': [{
+        text: '导航',
+        children: [{
+            text: '入门',
+            children: i18n.array(navigationLinks.start, 'zh-cn')
+        }, {
+            text: '依赖',
+            children: i18n.array(navigationLinks.library, 'zh-cn')
+        }, {
+            text: '配置',
+            children: i18n.array(navigationLinks.config, 'zh-cn')
+        }, {
+            text: '关于',
+            children: i18n.array(navigationLinks.about, 'zh-cn')
+        }]
+    }, {
+        text: '联系我们',
+        link: i18n.string(navigationLinks.about[2], 'zh-cn')
+    }]
+};
+
+export const sideBarItems = {
+    '/en/': [{
+        text: 'Get Started',
+        collapsible: true,
+        children: i18n.array(navigationLinks.start, 'en')
+    }, {
+        text: 'Libraries',
+        collapsible: true,
+        children: i18n.array(navigationLinks.library, 'en')
+    }, {
+        text: 'Configs',
+        collapsible: true,
+        children: i18n.array(navigationLinks.config, 'en')
+    }, {
+        text: 'About',
+        collapsible: true,
+        children: i18n.array(navigationLinks.about, 'en')
+    }],
+    '/zh-cn/': [{
+        text: '入门',
+        collapsible: true,
+        children: i18n.array(navigationLinks.start, 'zh-cn')
+    }, {
+        text: '依赖',
+        collapsible: true,
+        children: i18n.array(navigationLinks.library, 'zh-cn')
+    }, {
+        text: '配置',
+        collapsible: true,
+        children: i18n.array(navigationLinks.config, 'zh-cn')
+    }, {
+        text: '关于',
+        collapsible: true,
+        children: i18n.array(navigationLinks.about, 'zh-cn')
+    }]
+};

docs-source/src/.vuepress/configs/utils.ts

@@ -0,0 +1,39 @@
+export const env = {
+    dev: process.env.NODE_ENV === 'development'
+};
+
+export const i18n = {
+    space: ' ',
+    string: (content: string, locale: string) => {
+        return '/' + locale + content;
+    },
+    array: (contents: string[], locale: string) => {
+        const newContents: string[] = [];
+        contents.forEach((content) => {
+            newContents.push(i18n.string(content, locale));
+        });
+        return newContents;
+    }
+};
+
+export const markdown = {
+    injectLinks: (md: markdownit, maps: Record<string, string>[]) => {
+        const defaultRender = md.renderer.rules.link_open || function (tokens, idx, options, _env, self) {
+            return self.renderToken(tokens, idx, options);
+        };
+        md.renderer.rules.link_open = function (tokens, idx, options, env, self) {
+            const hrefIndex = tokens[idx].attrIndex('href');
+            let current = tokens[idx].attrs!![hrefIndex][1];
+            for (const map of maps) {
+                for (const [search, replace] of Object.entries(map)) {
+                    if (current.startsWith(search)) {
+                        current = current.replace(search, replace);
+                        tokens[idx].attrs!![hrefIndex][1] = current;
+                        break;
+                    }
+                }
+            }
+            return defaultRender(tokens, idx, options, env, self);
+        };
+    }
+};

docs-source/src/.vuepress/styles/index.scss

@@ -0,0 +1,179 @@
+$primary-color: rgb(99, 159, 112);
+$accent-color: rgb(130, 180, 140);
+$content-width: 965px;
+$scroll-bar-width: 8px;
+$scroll-bar-height: 6.5px;
+$scroll-bar-border-radius: 50px;
+$scroll-bar-track-color-code: rgb(86, 96, 110);
+$scroll-bar-thumb-hover-color-code: rgb(121, 135, 155);
+
+:root {
+    --c-brand: #{$primary-color};
+    --c-brand-light: #{$accent-color};
+    --content-width: #{$content-width};
+}
+
+code {
+    padding: 3px 5px 3px 5px;
+    border-radius: 5px;
+}
+
+.badge {
+    margin-bottom: 5px;
+}
+
+.custom-container {
+    border-radius: 5px;
+}
+
+.sidebar-item {
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+}
+
+.language-text {
+    ::-webkit-scrollbar-track {
+        background: #{$scroll-bar-track-color-code};
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: #{$scroll-bar-thumb-hover-color-code};
+    }
+}
+
+.language-kotlin {
+    ::-webkit-scrollbar-track {
+        background: #{$scroll-bar-track-color-code};
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: #{$scroll-bar-thumb-hover-color-code};
+    }
+}
+
+.language-java {
+    ::-webkit-scrollbar-track {
+        background: #{$scroll-bar-track-color-code};
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: #{$scroll-bar-thumb-hover-color-code};
+    }
+}
+
+.language-groovy {
+    ::-webkit-scrollbar-track {
+        background: #{$scroll-bar-track-color-code};
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: #{$scroll-bar-thumb-hover-color-code};
+    }
+}
+
+.language-xml {
+    ::-webkit-scrollbar-track {
+        background: #{$scroll-bar-track-color-code};
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: #{$scroll-bar-thumb-hover-color-code};
+    }
+}
+
+.hidden-anchor-page {
+    h6 {
+        color: transparent;
+        margin-bottom: -35px;
+        padding-top: 50px;
+    }
+}
+
+.code-page {
+    h1 {
+        font-size: 24pt;
+    }
+
+    h2 {
+        font-size: 18pt;
+    }
+
+    h3 {
+        font-size: 15pt;
+    }
+
+    h4 {
+        font-size: 12pt;
+    }
+
+    h5 {
+        font-size: 9.6pt;
+    }
+
+    h6 {
+        font-size: 8.4pt;
+    }
+
+    .symbol {
+        color: rgb(142, 155, 168);
+    }
+
+    .deprecated {
+        color: rgb(142, 155, 168);
+        text-decoration: line-through;
+    }
+}
+
+html {
+    scroll-behavior: smooth;
+
+    ::-webkit-scrollbar {
+        width: #{$scroll-bar-width};
+        height: #{$scroll-bar-height};
+    }
+
+    ::-webkit-scrollbar-track {
+        background: rgb(234, 236, 239);
+    }
+
+    ::-webkit-scrollbar-thumb {
+        background: rgb(189, 189, 189);
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: rgb(133, 133, 133);
+        border-radius: #{$scroll-bar-border-radius};
+    }
+}
+
+html.dark {
+    --c-brand: #{$primary-color};
+    --c-brand-light: #{$accent-color};
+    --content-width: #{$content-width};
+
+    ::-webkit-scrollbar {
+        width: #{$scroll-bar-width};
+        height: #{$scroll-bar-height};
+    }
+
+    ::-webkit-scrollbar-track {
+        background: rgb(41, 46, 53);
+    }
+
+    ::-webkit-scrollbar-thumb {
+        background: rgb(65, 72, 83);
+        border-radius: #{$scroll-bar-border-radius};
+    }
+
+    ::-webkit-scrollbar-thumb:hover {
+        background: rgb(56, 62, 72);
+        border-radius: #{$scroll-bar-border-radius};
+    }
+}