Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

Commit

Permalink
feat: docs website
Browse files Browse the repository at this point in the history
  • Loading branch information
YournameITManoah committed Oct 14, 2024
1 parent 681d81b commit f82e291
Show file tree
Hide file tree
Showing 135 changed files with 4,746 additions and 43 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@ yarn-error.log*
!.yarn/sdks
!.yarn/versions
.yarn/install-state.gz

# VitePress
docs/.vitepress/dist
docs/.vitepress/cache
70 changes: 70 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { defineConfig } from 'vitepress';
import { mapLocales, mapSearch } from './../utils/locales';
import { GH_REPO, GH_REPO_URL } from './../utils/constants';

const base = `/${GH_REPO}/`;

// https://vitepress.dev/reference/site-config
export default defineConfig({
base,
srcDir: './src',
cleanUrls: true,
lastUpdated: true,
markdown: { image: { lazyLoading: true } },
head: [
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '128x128',
href: `${base}icons/favicon-128x128.png`,
},
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '96x96',
href: `${base}icons/favicon-96x96.png`,
},
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '32x32',
href: `${base}icons/favicon-32x32.png`,
},
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '16x16',
href: `${base}icons/favicon-16x16.png`,
},
],
['link', { rel: 'icon', type: 'image/ico', href: `${base}favicon.ico` }],
[
'link',
{
rel: 'icon',
type: 'image/svg+xml',
href: `${base}logo-no-background.svg`,
},
],
],
locales: mapLocales(),
themeConfig: {
externalLinkIcon: true,
logo: '/icon.png',
outline: { level: 'deep' },
search: mapSearch(),
lastUpdated: { formatOptions: { dateStyle: 'full', forceLocale: true } },
socialLinks: [{ icon: 'github', link: GH_REPO_URL, ariaLabel: 'GitHub' }],
},
});
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-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-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,
#bd34fe 30%,
#41d1ff
);

--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 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;
}

26 changes: 26 additions & 0 deletions docs/locales/af.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
26 changes: 26 additions & 0 deletions docs/locales/am.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
26 changes: 26 additions & 0 deletions docs/locales/cmn-hans.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
26 changes: 26 additions & 0 deletions docs/locales/de.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
26 changes: 26 additions & 0 deletions docs/locales/el.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
26 changes: 26 additions & 0 deletions docs/locales/en.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"about": "About",
"backButtonTitle": "Back",
"closeText": "to close",
"darkModeSwitchLabel": "Appearance",
"darkModeSwitchTitle": "Switch to dark theme",
"description": "The documentation website for Meeting Media Manager (M³).",
"displayDetails": "Display detailed list",
"docFooterNext": "Next page",
"docFooterPrev": "Previous page",
"editLink": "Edit this page on Crowdin",
"faq": "FAQ",
"langMenuLabel": "Change language",
"lastUpdated": "Updated at",
"lightModeSwitchTitle": "Switch to light theme",
"navigateText": "to navigate",
"noResultsText": "No results for",
"outline": "On this page",
"reportIssue": "Report an issue",
"resetButtonTitle": "Reset search",
"returnToTopLabel": "Return to top",
"search": "Search",
"selectText": "to select",
"sidebarMenuLabel": "Menu",
"title": "M³ documentation"
}
Loading

0 comments on commit f82e291

Please sign in to comment.