https://github.com/jamdesk/homebrew-tap
Homebrew formulae for Jamdesk CLI
https://github.com/jamdesk/homebrew-tap
Last synced: 3 days ago
JSON representation
Homebrew formulae for Jamdesk CLI
- Host: GitHub
- URL: https://github.com/jamdesk/homebrew-tap
- Owner: jamdesk
- License: apache-2.0
- Created: 2026-01-27T20:33:28.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-03-09T18:54:43.000Z (3 months ago)
- Last Synced: 2026-03-10T00:38:19.611Z (3 months ago)
- Language: Ruby
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# Jamdesk Homebrew Tap
[](./LICENSE)
Homebrew formulae for [Jamdesk](https://www.jamdesk.com) CLI - the command-line tool for building and managing documentation sites.
## What is Jamdesk?
[Jamdesk](https://www.jamdesk.com) is a documentation platform that transforms MDX (Markdown + React components) into polished documentation websites. The CLI lets you preview docs locally, validate content, and manage your documentation workflow from the terminal.
**What the CLI does:**
- `jamdesk dev` - Preview documentation locally with hot reload
- `jamdesk validate` - Check docs.json schema and MDX syntax
- `jamdesk broken-links` - Find broken internal links
- `jamdesk init` - Initialize a new documentation project
**New to Jamdesk?** Check out the [documentation](https://www.jamdesk.com/docs) or the [quickstart guide](https://www.jamdesk.com/docs/quickstart) to get started.
## Installation
```bash
# One-liner
brew install jamdesk/tap/jamdesk
# Or tap first, then install
brew tap jamdesk/tap
brew install jamdesk
```
Verify the installation:
```bash
jamdesk --version
```
## Upgrading
```bash
brew upgrade jamdesk
```
## Uninstalling
```bash
brew uninstall jamdesk
brew untap jamdesk/tap
```
## Available Formulae
| Formula | Description |
|---------|-------------|
| `jamdesk` | Documentation platform CLI for local development and validation |
## Requirements
- macOS or Linux
- Homebrew
- Node.js 20+ (installed automatically as dependency)
## Alternative Installation
If you prefer not to use Homebrew:
```bash
# Via npm
npm install -g jamdesk
# Via curl (macOS/Linux)
curl -fsSL https://get.jamdesk.com | bash
# Via PowerShell (Windows)
irm https://get.jamdesk.com/win | iex
```
## Documentation
- [Jamdesk Documentation](https://www.jamdesk.com/docs) - Full platform docs
- [CLI Reference](https://www.jamdesk.com/docs/cli/overview) - All CLI commands
- [Local Development](https://www.jamdesk.com/docs/development/local-preview) - Preview docs locally
## Support
- Issues: [github.com/jamdesk/jamdesk-cli/issues](https://github.com/jamdesk/jamdesk-cli/issues)
## License
Apache 2.0