This repository powers dotfiles.io, the official documentation site for the Dotfiles / Trusted Shell Platform. Built with VuePress v1.9.8, it provides comprehensive guides for installation, configuration, aliases, functions, and advanced usage across 15 languages.

• Features
• Supported Languages
• Quick Start
• Development
• Build
• Project Structure
• Contributing
• License

• Multi-Language Support: Documentation available in 15 languages with flag-based language selector.
• SEO Optimized: JSON-LD structured data, OpenGraph, Twitter Cards, and semantic HTML.
• PWA Ready: Progressive Web App support for offline access.
• Accessibility: ARIA labels, keyboard navigation, and screen reader support.
• Performance: Optimized builds with HTML/CSS/JS minification and code splitting.
• Search: Integrated search functionality across all documentation.

Prerequisites

• Node.js v18+
• pnpm

# Clone the repository
git clone https://github.com/sebastienrousseau/dotfiles.github.io.git
cd dotfiles.github.io

# Install dependencies
pnpm install

# Start development server
pnpm run dev

Open http://localhost:8080 to view the site.

# Start local development server with hot reload
pnpm run dev

# Lint code and markdown
pnpm run lint

The development server watches for changes and automatically rebuilds.

# Production build
pnpm run build

Build output is generated in docs/.vuepress/dist/. The build process:

• Compiles all 736 pages across 15 locales
• Generates sitemap.xml
• Creates PWA service worker
• Minifies HTML, CSS, and JavaScript

dotfiles.github.io/
├── docs/
│   ├── .vuepress/
│   │   ├── config.ts           # Main VuePress configuration
│   │   ├── config/
│   │   │   ├── head/           # SEO meta tags
│   │   │   ├── nav/            # Navigation configs (15 locales)
│   │   │   └── sidebar/        # Sidebar configs (15 locales)
│   │   ├── public/             # Static assets (favicons, manifest)
│   │   └── styles/             # Stylus stylesheets
│   ├── about/                  # About page (EN)
│   ├── aliases/                # Alias documentation (EN)
│   ├── functions/              # Functions documentation (EN)
│   ├── paths/                  # Paths documentation (EN)
│   ├── fr/                     # French locale
│   ├── es/                     # Spanish locale
│   ├── de/                     # German locale
│   ├── pt/                     # Portuguese locale
│   ├── zh/                     # Chinese locale
│   ├── ja/                     # Japanese locale
│   ├── ko/                     # Korean locale
│   ├── ru/                     # Russian locale
│   ├── it/                     # Italian locale
│   ├── ar/                     # Arabic locale
│   ├── he/                     # Hebrew locale
│   ├── hi/                     # Hindi locale
│   ├── nl/                     # Dutch locale
│   ├── id/                     # Indonesian locale
│   └── README.md               # Homepage
├── package.json
└── README.md                   # This file

This repository is automatically deployed to GitHub Pages via GitHub Actions on every push to the main branch.

Live site: https://dotfiles.io

1. Fork the repository
2. Create a feature branch (git checkout -b feat/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feat/amazing-feature)
5. Open a Pull Request

Please ensure:

• All 15 locales are updated simultaneously for content changes
• pnpm run build passes without errors
• Front matter follows the schema guidelines

• Dotfiles Repository — The main dotfiles source code
• Live Documentation — The deployed documentation site

This project is licensed under the MIT License. See LICENSE for details.

↑ Back to Top