vault-link/docs

VaultLink Documentation

This directory contains the VaultLink documentation site built with VitePress.

Development

Prerequisites

• Node.js 18+
• npm

Setup

cd docs
npm install

Local Development

Start the development server with hot reload:

npm run dev

The site will be available at http://localhost:5173/vault-link/

Build

Build the static site:

npm run build

Output will be in .vitepress/dist/

Preview

Preview the built site:

npm run preview

Format

Format all markdown and TypeScript files:

npm run format

Check formatting without making changes:

npm run format:check

Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.

The deployment workflow is configured in .github/workflows/deploy-docs.yml.

Structure

docs/
├── .vitepress/
│   └── config.ts          # VitePress configuration
├── public/                # Static assets
│   └── logo.svg          # VaultLink logo
├── guide/                # User guides
│   ├── what-is-vaultlink.md
│   ├── getting-started.md
│   ├── server-setup.md
│   ├── obsidian-plugin.md
│   └── cli-client.md
├── architecture/         # Architecture documentation
│   ├── index.md
│   ├── sync-algorithm.md
│   └── data-flow.md
├── config/              # Configuration reference
│   ├── server.md
│   ├── authentication.md
│   └── advanced.md
└── index.md            # Home page

Writing Documentation

Markdown Features

VitePress supports:

• GitHub Flavored Markdown
• Custom containers (tip, warning, danger)
• Code syntax highlighting
• Mermaid diagrams
• Emoji 🚀

Custom Containers

::: tip
This is a tip
:::

::: warning
This is a warning
:::

::: danger
This is a danger message
:::

Code Blocks

```bash
npm install
```

```yaml
server:
    port: 3000
```

Contributing

When adding new pages:

1. Create the markdown file in the appropriate directory
2. Add it to the sidebar in .vitepress/config.ts
3. Test locally with npm run dev
4. Submit a pull request

License

MIT - Same as VaultLink