Skip to content

chore: add documentation #152

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 44 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Cloudinary Laravel
description: Laravel SDK for Cloudinary.
template: splash
hero:
tagline: "Null"
head:
- tag: title
content: Cloudinary Laravel - The Image & Video API for Laravel
---

import { CldImage } from "astro-cloudinary";

import ImageGrid from "@components/ImageGrid.astro";
import Button from "@components/Button.astro";

<div class="not-content text-center max-w-xl mx-auto mt-14 mb-20 md:mt-36 md:mb-44">
<h1 class="text-4xl sm:text-5xl md:text-6xl font-bold">Cloudinary Laravel</h1>

{" "}
<p class="text-xl mt-8">
High-performance image and video delivery and uploading at scale in Laravel
powered by Cloudinary.
</p>

<p class="flex items-center justify-center gap-6 mt-8 px-2">

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/62209650/196528621-b68e9e10-7e55-4c7d-9177-904cadbb4296.png" align="center" height="50" />
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/62209650/196528761-a815025a-271a-4d8e-ac7e-cea833728bf9.png" align="center" height="50" />
<img alt="Cloudinary" src="https://user-images.githubusercontent.com/62209650/196528761-a815025a-271a-4d8e-ac7e-cea833728bf9.png" align="center" height="50" />
</picture>

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/1045274/200928533-47539867-07ff-406e-aa8b-25c594652dc8.png" align="center" height="50" />
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/1045274/200928533-47539867-07ff-406e-aa8b-25c594652dc8.png" align="center" height="50" />
<img alt="Laravel" src="https://user-images.githubusercontent.com/1045274/200928533-47539867-07ff-406e-aa8b-25c594652dc8.png" align="center" height="50" />
</picture>

</p>
<p class="mt-10">
<Button href="/installation">Get Started</Button>
</p>
</div>
53 changes: 53 additions & 0 deletions docs/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Installing Cloudinary Laravel
description: Getting started with Cloudinary Laravel.
ogImageTitle: Installation
head:
- tag: title
content: Installation - Cloudinary Laravel
---
import { Tabs, TabItem, Steps } from '@astrojs/starlight/components';
import CodeBlock from '@components/CodeBlock.astro';

## Getting Started

<Steps>
<ol class="!mt-10">
<li>
### Installation

Requires PHP 8.2+ and Laravel 11+.

<CodeBlock alwaysExpanded>
```
composer require cloudinary-labs/cloudinary-laravel
```
</CodeBlock>
</li>
<li>
### Configuration

After you have installed the SDK, you can invoke the install command to set everything up:

<CodeBlock alwaysExpanded>
```
php artisan cloudinary:install
```
</CodeBlock>

Add your Cloudinary credentials to your .env file:

<CodeBlock alwaysExpanded>
```
CLOUDINARY_URL=cloudinary://API_KEY:API_SECRET@CLOUD_NAME
CLOUDINARY_UPLOAD_PRESET=your_upload_preset
CLOUDINARY_NOTIFICATION_URL=
```
</CodeBlock>
</li>
</ol>
</Steps>

:::tip
Don't have a Cloudinary account? <a href="https://cloudinary.com/users/register_free?utm_campaign=devx_laravelcloudinary&utm_medium=referral&utm_source=laravelcloudinary">Sign up for free</a> on cloudinary.com!
:::