feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base:main
Choose a base branch
from
Draft

feat: Complete VitePress documentation site with pt-BR and English #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29a49d4
Initial plan
Copilot Mar 5, 2026
6066958
feat: add VitePress documentation site with pt-BR and English content
Copilot Mar 5, 2026
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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: Complete VitePress documentation site with pt-BR and English#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Draft

Copilot
wants to merge
2
commits into

base:main
Choose a base branch

from

 Draft


feat: Complete VitePress documentation site with pt-BR and English
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
29a49d4

Initial plan


Copilot Mar 5, 2026
6066958

feat: add VitePress documentation site with pt-BR and English content


Copilot Mar 5, 2026

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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff 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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Loading