GetHomepage IntelliSense

YAML IntelliSense, autocompletion, validation and snippets for GetHomepage configuration files.

Features

• Schema Validation — Real-time error highlighting for invalid properties, wrong types, and missing required fields
• Autocompletion — Smart suggestions for all configuration properties, widget types, themes, colors, and more
• Hover Documentation — Hover over any property to see its description and allowed values
• Snippets — Ready-to-use templates for services, bookmarks, widgets, layouts, and more
• 151 Widget Types — Full support for all GetHomepage service widgets
• Custom Language ID — Scoped yaml-homepage language so IntelliSense only activates on your homepage config files

Supported Files

Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "GetHomepage IntelliSense"
4. Click Install

From .vsix (Local)

# Clone and build
git clone https://github.com/nicolasaigner/gethomepage-intellisense.git
cd gethomepage-intellisense
npm install
npm run package

# Install the generated .vsix file
code --install-extension gethomepage-intellisense-*.vsix

Setup

After installing, add the following to your workspace's .vscode/settings.json to associate your GetHomepage config files with the extension:

{
  "files.associations": {
    // Adjust the path to match your project structure
    "config/*.yaml": "yaml-homepage",
  },
}

Tip: You can be more specific if you have other YAML files in the same folder:

{
  "files.associations": {
    "config/settings.yaml": "yaml-homepage",
    "config/services.yaml": "yaml-homepage",
    "config/widgets.yaml": "yaml-homepage",
    "config/bookmarks.yaml": "yaml-homepage",
    "config/docker.yaml": "yaml-homepage",
    "config/kubernetes.yaml": "yaml-homepage",
    "config/proxmox.yaml": "yaml-homepage",
  },
}

That's it! Open any associated file and start getting IntelliSense.

Snippets

Type the snippet prefix and press Tab or Enter to expand:

Supported Widget Types

All 151 service widget types are recognized and validated:

Requirements

• YAML Language Support by Red Hat — Installed automatically as a dependency

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

Related

• GetHomepage — A highly customizable homepage (or startpage / application dashboard)
• GetHomepage GitHub
• YAML Language Support

License

This project is licensed under the MIT License — see the LICENSE file for details.

Made with ❤️ for the GetHomepage community