Skip to content

Commit

Permalink
chore: pull no-rebase
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 3, 2024
2 parents 9a3bc51 + 86bff56 commit 62f9aae
Show file tree
Hide file tree
Showing 32 changed files with 576 additions and 7 deletions.
2 changes: 2 additions & 0 deletions docs/.gitignore
@@ -0,0 +1,2 @@
.vitepress/cache
.vitepress/dist
28 changes: 28 additions & 0 deletions docs/.vitepress/config.ts
@@ -0,0 +1,28 @@
import { defineConfig } from 'vitepress'
import en from './locales/en'
import ru from './locales/ru'

export default defineConfig({
title: 'Mafl',
base: '/mafl/',
themeConfig: {
search: {
provider: 'local',
},

logo: {
src: '/logotype.svg',
innerWidth: 50,
height: 50,
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/hywax/mafl' },
],
},

locales: {
root: { label: 'English', ...en },
ru: { label: 'Русский', ...ru },
},
})
66 changes: 66 additions & 0 deletions docs/.vitepress/locales/en.ts
@@ -0,0 +1,66 @@
import { defineConfig } from 'vitepress'
import { getVersion } from '../utils'

export default defineConfig({
description: 'Intuitive service for organizing your homepage',
lang: 'en-US',
themeConfig: {
nav: [
{ text: 'Home', link: '/' },
{ text: 'Configuration', link: '/reference/configuration' },
{ text: 'Showcase', link: '/community/showcase' },
{
text: getVersion(),
items: [
{ text: 'Changelog', link: '/other/changelog' },
{ text: 'Contributing', link: '/community/contributing' },
],
},
],

sidebar: [
{
text: 'Guide',
base: '/guide',
items: [
{ text: 'What is Mafl?', link: '/what-is' },
{ text: 'Getting Started', link: '/getting-started' },
{ text: 'Deployment', link: '/deployment' },
],
},
{
text: 'Reference',
base: '/reference',
items: [
{ text: 'Configuration', link: '/configuration' },
],
},
{
text: 'Services',
base: '/services',
items: [
{ text: 'Base', link: '/base' },
],
},
{
text: 'Community',
base: '/community',
collapsed: true,
items: [
{ text: 'Showcase', link: '/showcase' },
{ text: 'Development', link: '/development' },
{ text: 'Contributing', link: '/contributing' },
],
},
{
text: 'Other',
base: '/other',
collapsed: true,
items: [
{ text: 'Changelog', link: '/changelog' },
{ text: 'License', link: '/license' },
],
},
],
},
})
66 changes: 66 additions & 0 deletions docs/.vitepress/locales/ru.ts
@@ -0,0 +1,66 @@
import { defineConfig } from 'vitepress'
import { getVersion } from '../utils'

export default defineConfig({
description: 'Intuitive service for organizing your homepage',
lang: 'ru-RU',
themeConfig: {
nav: [
{ text: 'Home', link: '/ru/' },
{ text: 'Configuration', link: '/ru/reference/configuration' },
{ text: 'Showcase', link: '/ru/community/showcase' },
{
text: getVersion(),
items: [
{ text: 'Changelog', link: '/ru/other/changelog' },
{ text: 'Contributing', link: '/ru/community/contributing' },
],
},
],

sidebar: [
{
text: 'Guide',
base: '/ru/guide',
items: [
{ text: 'What is Mafl?', link: '/what-is' },
{ text: 'Getting Started', link: '/getting-started' },
{ text: 'Deployment', link: '/deployment' },
],
},
{
text: 'Reference',
base: '/ru/reference',
items: [
{ text: 'Configuration', link: '/configuration' },
],
},
{
text: 'Services',
base: '/ru/services',
items: [
{ text: 'Base', link: '/base' },
],
},
{
text: 'Community',
base: '/ru/community',
collapsed: true,
items: [
{ text: 'Showcase', link: '/showcase' },
{ text: 'Development', link: '/development' },
{ text: 'Contributing', link: '/contributing' },
],
},
{
text: 'Other',
base: '/ru/other',
collapsed: true,
items: [
{ text: 'Changelog', link: '/changelog' },
{ text: 'License', link: '/license' },
],
},
],
},
})
6 changes: 6 additions & 0 deletions docs/.vitepress/theme/custom.css
@@ -0,0 +1,6 @@
:root {
--vp-c-brand-1: #91c198;
--vp-c-brand-2: #7cb484;
--vp-c-brand-3: #609966;
--vp-c-brand-soft: #eaf4ec;
}
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.ts
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
5 changes: 5 additions & 0 deletions docs/.vitepress/utils/index.ts
@@ -0,0 +1,5 @@
import currentPackage from '../../../package.json'

export function getVersion() {
return currentPackage.version || '0.0.0'
}
1 change: 1 addition & 0 deletions docs/CNAME
@@ -0,0 +1 @@
mafl.hywax.space
1 change: 1 addition & 0 deletions docs/community/contributing.md
@@ -0,0 +1 @@
# Contributing
1 change: 1 addition & 0 deletions docs/community/development.md
@@ -0,0 +1 @@
# Development
1 change: 1 addition & 0 deletions docs/community/showcase.md
@@ -0,0 +1 @@
# Showcase
1 change: 1 addition & 0 deletions docs/guide/deployment.md
@@ -0,0 +1 @@
# Deployment
1 change: 1 addition & 0 deletions docs/guide/getting-started.md
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions docs/guide/what-is.md
@@ -0,0 +1 @@
# What is Mafl?
50 changes: 50 additions & 0 deletions docs/index.md
@@ -0,0 +1,50 @@
---
layout: home

hero:
name: "Mafl"
text: "Documentation"
tagline: Intuitive service for organizing your homepage
actions:
- theme: brand
text: Getting started
link: /guide/getting-started
- theme: alt
text: What is Mafl?
link: /guide/what-is
- theme: alt
text: View on GitHub
link: https://github.com/hywax/mafl

features:
- title: Privacy
icon: 🔐
details: All requests to third-party services occur in backend.
- title: Real-time
icon:
details: Interactive cards with extra information.
- title: Multi-language
icon: 🌎
details: Supports multiple languages.
- title: Themes
icon: 🎨
details: Customize the look to your liking.
- title: Grouping
icon: 🗂
details: Create custom service groups.
- title: Easy setup
icon: 👌
details: A few lines of yaml and your homepage is ready to go.
- title: Fast
icon: 🚀
details: Everything is fast and free of hang-ups.
- title: Docker
icon: 🐳
details: Optimized docker images for popular platforms.
- title: Free
icon:
details: Mafl is completely free and open source.
- title: PWA
icon: 📲
details: Installable application.
---
Empty file added docs/other/changelog.md
Empty file.
1 change: 1 addition & 0 deletions docs/other/license.md
@@ -0,0 +1 @@
# License
1 change: 1 addition & 0 deletions docs/reference/configuration.md
@@ -0,0 +1 @@
# Configuration
1 change: 1 addition & 0 deletions docs/ru/community/contributing.md
@@ -0,0 +1 @@
# Contributing
1 change: 1 addition & 0 deletions docs/ru/community/development.md
@@ -0,0 +1 @@
# Development
1 change: 1 addition & 0 deletions docs/ru/community/showcase.md
@@ -0,0 +1 @@
# Showcase
1 change: 1 addition & 0 deletions docs/ru/guide/deployment.md
@@ -0,0 +1 @@
# Deployment
1 change: 1 addition & 0 deletions docs/ru/guide/getting-started.md
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions docs/ru/guide/what-is.md
@@ -0,0 +1 @@
# What is Mafl?
50 changes: 50 additions & 0 deletions docs/ru/index.md
@@ -0,0 +1,50 @@
---
layout: home

hero:
name: "Mafl"
text: "Documentation"
tagline: Intuitive service for organizing your homepage
actions:
- theme: brand
text: Getting started
link: /ru/guide/getting-started
- theme: alt
text: What is Mafl?
link: /ru/guide/what-is
- theme: alt
text: View on GitHub
link: https://github.com/hywax/mafl

features:
- title: Privacy
icon: 🔐
details: All requests to third-party services occur in backend.
- title: Real-time
icon:
details: Interactive cards with extra information.
- title: Multi-language
icon: 🌎
details: Supports multiple languages.
- title: Themes
icon: 🎨
details: Customize the look to your liking.
- title: Grouping
icon: 🗂
details: Create custom service groups.
- title: Easy setup
icon: 👌
details: A few lines of yaml and your homepage is ready to go.
- title: Fast
icon: 🚀
details: Everything is fast and free of hang-ups.
- title: Docker
icon: 🐳
details: Optimized docker images for popular platforms.
- title: Free
icon:
details: Mafl is completely free and open source.
- title: PWA
icon: 📲
details: Installable application.
---
Empty file added docs/ru/other/changelog.md
Empty file.
1 change: 1 addition & 0 deletions docs/ru/other/license.md
@@ -0,0 +1 @@
# License
1 change: 1 addition & 0 deletions docs/ru/reference/configuration.md
@@ -0,0 +1 @@
# Configuration
1 change: 1 addition & 0 deletions docs/ru/services/base.md
@@ -0,0 +1 @@
# Base
1 change: 1 addition & 0 deletions docs/services/base.md
@@ -0,0 +1 @@
# Base
8 changes: 6 additions & 2 deletions package.json
Expand Up @@ -12,7 +12,10 @@
"postinstall": "nuxi prepare",
"lint": "eslint . --fix",
"typecheck": "nuxi typecheck",
"prepare": "husky install"
"prepare": "husky install",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
},
"dependencies": {
"@vueuse/nuxt": "^10.7.0",
Expand All @@ -37,6 +40,7 @@
"nuxt": "^3.9.0",
"nuxt-icon": "^0.6.8",
"typescript": "^5.3.3",
"vitepress": "^1.0.0-rc.34",
"vue-tsc": "^1.8.27"
},
"resolutions": {
Expand All @@ -45,4 +49,4 @@
"lint-staged": {
"*.ts": "yarn run lint"
}
}
}

0 comments on commit 62f9aae

Please sign in to comment.