Skip to content
Draft
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
41 changes: 41 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Deploy Docs

on:
push:
branches:
- main
paths:
- "docs/**"

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Install dependencies
run: cd docs && npm ci

- name: Build docs
run: cd docs && npm run docs:build

# Primary: Cloudflare Pages
- name: Deploy to Cloudflare Pages
uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
command: pages deploy docs/.vitepress/dist --project-name=arandu-docs

# Fallback: GitHub Pages
- name: Deploy to GitHub Pages (fallback)
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/.vitepress/dist
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,8 @@ yarn-error.log*

# Examples (private reference files)
examples/

# Docs
docs/.vitepress/dist
docs/.vitepress/cache
docs/node_modules
56 changes: 56 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import { defineConfig } from 'vitepress'
import { ptBR } from './locales/pt-BR'
import { en } from './locales/en'

export default defineConfig({
title: 'Arandu',
description: 'Markdown viewer and AI workspace',
cleanUrls: true,
lastUpdated: true,

head: [
['link', { rel: 'icon', type: 'image/svg+xml', href: '/icon.svg' }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
['link', { rel: 'apple-touch-icon', href: '/apple-touch-icon.png' }],
['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
['link', { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }],
[
'link',
{
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap'
}
],
['meta', { name: 'theme-color', content: '#2D1B69' }],
['meta', { property: 'og:type', content: 'website' }],
['meta', { property: 'og:title', content: 'Arandu — Markdown viewer and AI workspace' }],
[
'meta',
{
property: 'og:description',
content: 'Markdown viewer and AI workspace for macOS, Linux, and Windows.'
}
]
],

locales: {
root: {
label: 'Português',
lang: 'pt-BR',
...ptBR
},
en: {
label: 'English',
lang: 'en-US',
...en
}
},

themeConfig: {
logo: '/icon.svg',
socialLinks: [{ icon: 'github', link: 'https://github.com/devitools/arandu' }],
search: {
provider: 'local'
}
}
})
106 changes: 106 additions & 0 deletions docs/.vitepress/locales/en.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import type { DefaultTheme, LocaleSpecificConfig } from 'vitepress'

export const en: LocaleSpecificConfig<DefaultTheme.Config> = {
title: 'Arandu',
description: 'Markdown viewer and AI workspace',
themeConfig: {
nav: [
{ text: 'Guide', link: '/en/guide/introduction', activeMatch: '/en/guide/' },
{ text: 'Features', link: '/en/features/markdown', activeMatch: '/en/features/' },
{ text: 'Reference', link: '/en/reference/cli', activeMatch: '/en/reference/' },
{
text: 'Download',
link: 'https://github.com/devitools/arandu/releases/latest'
}
],
sidebar: {
'/en/guide/': [
{
text: 'Getting Started',
items: [
{ text: 'Introduction', link: '/en/guide/introduction' },
{ text: 'Installation', link: '/en/guide/installation' },
{ text: 'Quick Start', link: '/en/guide/quick-start' }
]
},
{
text: 'Essentials',
items: [
{ text: 'Viewing Markdown', link: '/en/guide/viewing-markdown' },
{ text: 'Navigation', link: '/en/guide/navigation' },
{ text: 'Themes', link: '/en/guide/themes' },
{ text: 'Keyboard Shortcuts', link: '/en/guide/shortcuts' }
]
}
],
'/en/features/': [
{
text: 'Viewing',
items: [
{ text: 'Markdown', link: '/en/features/markdown' },
{ text: 'Live Reload', link: '/en/features/live-reload' },
{ text: 'Themes', link: '/en/features/themes' }
]
},
{
text: 'Voice',
items: [
{ text: 'Whisper', link: '/en/features/whisper' },
{ text: 'Whisper Configuration', link: '/en/features/whisper-config' }
]
},
{
text: 'Workspace',
items: [
{ text: 'Workspace', link: '/en/features/workspace' },
{ text: 'Sessions & Modes', link: '/en/features/sessions' },
{ text: 'Plan', link: '/en/features/plan' }
]
},
{
text: 'Review',
items: [
{ text: 'Comments', link: '/en/features/comments' },
{ text: 'Review', link: '/en/features/review' },
{ text: 'Integrations', link: '/en/features/integrations' }
]
}
],
'/en/reference/': [
{
text: 'Reference',
items: [
{ text: 'CLI', link: '/en/reference/cli' },
{ text: 'IPC', link: '/en/reference/ipc' },
{ text: 'Settings', link: '/en/reference/settings' },
{ text: 'Languages', link: '/en/reference/languages' }
]
}
]
},
editLink: {
pattern: 'https://github.com/devitools/arandu/edit/main/docs/:path',
text: 'Edit this page on GitHub'
},
lastUpdated: {
text: 'Updated at',
formatOptions: { dateStyle: 'short' }
},
docFooter: {
prev: 'Previous',
next: 'Next'
},
outline: {
label: 'On this page'
},
returnToTopLabel: 'Return to top',
sidebarMenuLabel: 'Menu',
darkModeSwitchLabel: 'Theme',
lightModeSwitchTitle: 'Switch to light mode',
darkModeSwitchTitle: 'Switch to dark mode',
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2024 devitools'
}
}
}
106 changes: 106 additions & 0 deletions docs/.vitepress/locales/pt-BR.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import type { DefaultTheme, LocaleSpecificConfig } from 'vitepress'

export const ptBR: LocaleSpecificConfig<DefaultTheme.Config> = {
title: 'Arandu',
description: 'Visualizador de Markdown e workspace com IA',
themeConfig: {
nav: [
{ text: 'Guia', link: '/guia/introducao', activeMatch: '/guia/' },
{ text: 'Funcionalidades', link: '/funcionalidades/markdown', activeMatch: '/funcionalidades/' },
{ text: 'Referência', link: '/referencia/cli', activeMatch: '/referencia/' },
{
text: 'Download',
link: 'https://github.com/devitools/arandu/releases/latest'
}
],
sidebar: {
'/guia/': [
{
text: 'Primeiros Passos',
items: [
{ text: 'Introdução', link: '/guia/introducao' },
{ text: 'Instalação', link: '/guia/instalacao' },
{ text: 'Início Rápido', link: '/guia/inicio-rapido' }
]
},
{
text: 'Essenciais',
items: [
{ text: 'Visualizando Markdown', link: '/guia/visualizando-markdown' },
{ text: 'Navegação', link: '/guia/navegacao' },
{ text: 'Temas', link: '/guia/temas' },
{ text: 'Atalhos de Teclado', link: '/guia/atalhos' }
]
}
],
'/funcionalidades/': [
{
text: 'Visualização',
items: [
{ text: 'Markdown', link: '/funcionalidades/markdown' },
{ text: 'Live Reload', link: '/funcionalidades/live-reload' },
{ text: 'Temas', link: '/funcionalidades/temas' }
]
},
{
text: 'Voz',
items: [
{ text: 'Whisper', link: '/funcionalidades/whisper' },
{ text: 'Configuração do Whisper', link: '/funcionalidades/whisper-config' }
]
},
{
text: 'Workspace',
items: [
{ text: 'Workspace', link: '/funcionalidades/workspace' },
{ text: 'Sessões e Modos', link: '/funcionalidades/sessoes' },
{ text: 'Plano', link: '/funcionalidades/plano' }
]
},
{
text: 'Revisão',
items: [
{ text: 'Comentários', link: '/funcionalidades/comentarios' },
{ text: 'Review', link: '/funcionalidades/review' },
{ text: 'Integrações', link: '/funcionalidades/integracoes' }
]
}
],
'/referencia/': [
{
text: 'Referência',
items: [
{ text: 'CLI', link: '/referencia/cli' },
{ text: 'IPC', link: '/referencia/ipc' },
{ text: 'Configurações', link: '/referencia/configuracoes' },
{ text: 'Idiomas', link: '/referencia/idiomas' }
]
}
]
},
editLink: {
pattern: 'https://github.com/devitools/arandu/edit/main/docs/:path',
text: 'Editar esta página no GitHub'
},
lastUpdated: {
text: 'Atualizado em',
formatOptions: { dateStyle: 'short' }
},
docFooter: {
prev: 'Anterior',
next: 'Próximo'
},
outline: {
label: 'Nesta página'
},
returnToTopLabel: 'Voltar ao topo',
sidebarMenuLabel: 'Menu',
darkModeSwitchLabel: 'Tema',
lightModeSwitchTitle: 'Mudar para modo claro',
darkModeSwitchTitle: 'Mudar para modo escuro',
footer: {
message: 'Lançado sob a licença MIT.',
copyright: 'Copyright © 2024 devitools'
}
}
}
51 changes: 51 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
:root {
--vp-font-family-base: 'Inter', sans-serif;
--vp-font-family-mono: 'JetBrains Mono', monospace;

/* Brand colors - Light mode */
--vp-c-brand-1: #2d1b69;
--vp-c-brand-2: #3d2689;
--vp-c-brand-3: #4d31a9;
--vp-c-brand-soft: rgba(45, 27, 105, 0.1);

/* Tip/info colors - Gold accent */
--vp-c-tip-1: #d4821e;
--vp-c-tip-2: #f4c430;
--vp-c-tip-soft: rgba(244, 196, 48, 0.1);
}

.dark {
/* Brand colors - Dark mode */
--vp-c-brand-1: #8b7bc7;
--vp-c-brand-2: #9d8fd4;
--vp-c-brand-3: #af9fd0;
--vp-c-brand-soft: rgba(139, 123, 199, 0.16);

/* Tip/info colors - Gold accent */
--vp-c-tip-1: #f4c430;
--vp-c-tip-2: #d4821e;
--vp-c-tip-soft: rgba(244, 196, 48, 0.16);
}

/* Hero gradient on name */
.VPHero .name .clip {
background: linear-gradient(135deg, #f4c430, #d4821e) !important;
-webkit-background-clip: text !important;
-webkit-text-fill-color: transparent !important;
background-clip: text !important;
}

/* Pronunciation helper class */
.pronunciation {
font-style: italic;
color: var(--vp-c-text-2);
font-size: 0.95em;
}

.pronunciation .ipa {
font-family: var(--vp-font-family-mono);
background: var(--vp-c-bg-soft);
padding: 2px 6px;
border-radius: 4px;
font-style: normal;
}
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading