Skip to content

Commit

Permalink
docs: migrate to vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
negezor committed Nov 29, 2023
1 parent 704b006 commit af21fb9
Show file tree
Hide file tree
Showing 12 changed files with 1,187 additions and 1,643 deletions.
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@ app.ts
app.js
app.mjs

docs/.vuepress/dist
docs/.vuepress/.temp
docs/.vuepress/.cache
docs/.vitepress/dist
docs/.vitepress/cache
147 changes: 147 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'VK-IO',
description: 'Modern VK API SDK for Node.js',
base: '/vk-io/',

head: [
['meta', {
name: 'theme-color',
content: '#44668D'
}],
['meta', {
name: 'apple-mobile-web-app-capable',
content: 'yes'
}],
['meta', {
name: 'apple-mobile-web-app-status-bar-style',
content: 'black'
}]
],

lastUpdated: false,

themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: '/logo.svg',

nav: [
{
text: 'Guide [RU]',
link: '/ru/guide/introduction',
},
{
text: 'Community',
items: [
{
text: 'Telegram [RU]',
link: 'https://t.me/vkio_ru',
}
]
},
{
text: 'References',
link: '/references/'
},
{
text: 'Examples',
link: 'https://github.com/negezor/vk-io/tree/master/docs/examples',
},
],

sidebar: [
{
text: 'Основы',
collapsed: false,
items: [
{
text: 'Введение',
link: '/ru/guide/introduction',
},
{
text: 'Установка',
link: '/ru/guide/installation',
},
{
text: 'Модули',
link: '/ru/guide/modules',
},
{
text: 'API',
link: '/ru/guide/api',
},
{
text: 'Загрузка файлов',
link: '/ru/guide/upload',
},
{
text: 'Polling/Webhook',
link: '/ru/guide/updates',
},
{
text: 'Клавиатура',
link: '/ru/guide/keyboard',
},
{
text: 'Сбор данных',
link: '/ru/guide/collect',
},
{
text: 'Прикрепления',
link: '/ru/guide/attachments',
},
{
text: 'Контексты',
link: '/ru/guide/contexts',
},
{
text: 'Утилиты',
link: '/ru/guide/utils'
},
]
},
{
text: 'Миграции',
collapsed: false,
items: [
{
text: 'Миграция на 4 версию',
link: '/ru/guide/migration-to-v4',
},
]
}
],

socialLinks: [
{
icon: 'github',
link: 'https://github.com/negezor/vk-io'
},
{
icon: {
svg: '<svg xmlns="http://www.w3.org/2000/svg" data-name="Livello 1" viewBox="0 0 240 240"><defs><linearGradient id="a" x1="120" x2="120" y1="240" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#1d93d2"/><stop offset="1" stop-color="#38b0e3"/></linearGradient></defs><circle cx="120" cy="120" r="120" fill="url(#a)"/><path fill="#c8daea" d="m81.229 128.772 14.237 39.406s1.78 3.687 3.686 3.687 30.255-29.492 30.255-29.492l31.525-60.89L81.737 118.6Z"/><path fill="#a9c6d8" d="m100.106 138.878-2.733 29.046s-1.144 8.9 7.754 0 17.415-15.763 17.415-15.763"/><path fill="#fff" d="M81.486 130.178 52.2 120.636s-3.5-1.42-2.373-4.64c.232-.664.7-1.229 2.1-2.2 6.489-4.523 120.106-45.36 120.106-45.36s3.208-1.081 5.1-.362a2.766 2.766 0 0 1 1.885 2.055 9.357 9.357 0 0 1 .254 2.585c-.009.752-.1 1.449-.169 2.542-.692 11.165-21.4 94.493-21.4 94.493s-1.239 4.876-5.678 5.043a8.13 8.13 0 0 1-5.925-2.292c-8.711-7.493-38.819-27.727-45.472-32.177a1.27 1.27 0 0 1-.546-.9c-.093-.469.417-1.05.417-1.05s52.426-46.6 53.821-51.492c.108-.379-.3-.566-.848-.4-3.482 1.281-63.844 39.4-70.506 43.607a3.21 3.21 0 0 1-1.48.09Z"/></svg>'
},
link: 'https://t.me/vkio_ru'
}
]
},

locales: {
'/': {
lang: 'en-US',
label: 'EN',
description: 'Modern VK API SDK for Node.js',
},
'/ru/': {
lang: 'ru-RU',
label: 'RU',
description: 'Современный VK API SDK для Node.js'
}
},

ignoreDeadLinks: [
'./packages/authorization/README'
]
})
117 changes: 0 additions & 117 deletions docs/.vuepress/config.ts

This file was deleted.

4 changes: 0 additions & 4 deletions docs/.vuepress/public/logo.svg

This file was deleted.

16 changes: 0 additions & 16 deletions docs/README.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "VK-IO"
# text: "Modern VK API SDK for Node.js"
tagline: This is a powerful Node.js module that allows you to easily interact with the API VK 🚀
image:
src: /logo.svg
alt: 'Logo'
actions:
- theme: brand
text: Getting Started [RU]
link: /ru/guide/introduction
- theme: alt
text: API Examples
link: https://github.com/negezor/vk-io/tree/master/docs/examples

features:
- title: Approachable
details: The library already covers all popular tasks
- title: Versatile
details: All basic things are available in convenience abstractions
- title: Typings
details: Trust your code more with typing

footer: Released under the MIT License. Copyright © 2016-2023 Negezor
---

File renamed without changes.
16 changes: 0 additions & 16 deletions docs/ru/README.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/ru/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "VK-IO"
# text: "Modern VK API SDK for Node.js"
tagline: Это мощный Node.js модуль, который позволяет вам легко взаимодействовать с API ВКонтакте 🚀
image:
src: /logo.svg
alt: 'Logo'
actions:
- theme: brand
text: Начать
link: /ru/guide/introduction
- theme: alt
text: Примеры API
link: https://github.com/negezor/vk-io/tree/master/docs/examples

features:
- title: Доступная
details: Библиотека уже охватывает все популярные задачи
- title: Разносторонняя
details: Все базовые вещи доступны в удобных абстракциях
- title: Типизация
details: Больше доверяйте своему коду благодаря типизации

footer: Released under the MIT License. Copyright © 2016-2023 Negezor
---

Loading

0 comments on commit af21fb9

Please sign in to comment.