Skip to content
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

NEXT Figma Documentation and Guide #2899

Open
wants to merge 58 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
1b0538e
Add Setup Figma Design System Documentation
mmailaender Oct 2, 2024
e900b61
Switch to ProcessSteps
mmailaender Oct 2, 2024
1129bfd
Update CTA 2nd chapter
mmailaender Oct 2, 2024
651d0c3
Chapter complition styles updates
bohdank1995 Oct 7, 2024
07f47cb
Move ChapterCompletion into reusable component
mmailaender Oct 17, 2024
26d55f7
Remove dedicated dependency sharp
mmailaender Oct 17, 2024
60cb4f0
Add copy for Figma intro page
mmailaender Oct 22, 2024
e8f441d
Figma chapter section style updates
bohdank1995 Oct 24, 2024
c50ea89
Plan card responsivenes
bohdank1995 Oct 24, 2024
045fad4
Format and changed text of CTA.
mmailaender Oct 24, 2024
41591c7
Resolve merge conflict
mmailaender Oct 24, 2024
1f2c09d
Final polishing
bohdank1995 Oct 24, 2024
ca83ecf
button position change
bohdank1995 Oct 24, 2024
0897870
Revert pnpm-lock.yaml
mmailaender Oct 24, 2024
91bdfb3
Merge branch 'next' into docs/figma
mmailaender Oct 24, 2024
93bdec2
Fix: Changed figma doc component from astro to svelte
mmailaender Oct 24, 2024
8206b8d
Merge branch 'docs/figma' of https://github.com/Etesie/skeleton into …
mmailaender Oct 24, 2024
8995051
Run pnpm format
mmailaender Oct 24, 2024
9bba2f6
Modify Figma sections, implement Image component
endigo9740 Oct 24, 2024
ceb2b09
Merge pull request #2 from skeletonlabs/docs/figma
mmailaender Oct 25, 2024
b5b6584
Add Sharp as a dependency for Astro Image
endigo9740 Oct 25, 2024
63f609f
Merge pull request #3 from skeletonlabs/docs/figma
mmailaender Oct 25, 2024
0d75863
Import custom theme guide
bohdank1995 Oct 29, 2024
c0dc250
Remove Figma from left navigation pane
mmailaender Oct 29, 2024
d47e779
Update text for Figma tutorial chapter 1 and 2
mmailaender Oct 30, 2024
70ab459
replacing png with webp
bohdank1995 Nov 5, 2024
96a9aff
Fix: Use the correct image in chapter 2 for Switch theme
mmailaender Nov 5, 2024
62bbf14
Merge branch 'next' into docs/figma
mmailaender Nov 6, 2024
c75c478
Add Prerequisites for chapter 2 and move disclaimer one process step …
mmailaender Nov 12, 2024
44d0ff3
Put Notes into blockquote
mmailaender Nov 12, 2024
c2d9758
Fix typo: Apply custom theme in project
mmailaender Nov 12, 2024
203adbd
Fix text for "Pair Figma with Skeleton" paragraph
mmailaender Nov 12, 2024
ccac016
Remove emphasize for Get Access
mmailaender Nov 13, 2024
47990b8
landing page v2
bohdank1995 Nov 25, 2024
54071d4
landing page updates
bohdank1995 Nov 25, 2024
af8fa2b
small fixes
bohdank1995 Nov 26, 2024
7119c17
hide native headers
bohdank1995 Nov 26, 2024
0bb6238
fixed gap between headline and subtitle
bohdank1995 Nov 26, 2024
9420848
HideHeader from svelte to astro
bohdank1995 Nov 26, 2024
fb98481
Include Polar checkout
mmailaender Nov 29, 2024
099168f
Fix dark/ligh mode for 2nd buy button
mmailaender Nov 29, 2024
2e4ab05
Formatted figma.mdx
mmailaender Dec 4, 2024
f3b662f
Create wireframes v1
bohdank1995 Dec 5, 2024
3e8e2e6
Revert "Create wireframes v1"
mmailaender Dec 5, 2024
601f969
Created chaper-3 and updated chapter-1
bohdank1995 Dec 9, 2024
85b0bf1
Merge pull request #4 from Etesie/next
mmailaender Dec 9, 2024
05f7e3c
chapter-3, updated title and subtitle
bohdank1995 Dec 9, 2024
a7ba960
Merge pull request #5 from Etesie/next
mmailaender Dec 10, 2024
c998836
Repositioned landing page for figma
mmailaender Dec 10, 2024
f093e87
polish Figma page UI
bohdank1995 Dec 12, 2024
112a02b
Updated figma UI kit docs page
bohdank1995 Dec 12, 2024
4122420
Figma docs update
bohdank1995 Dec 14, 2024
9a56d63
Move chapters to guide section
mmailaender Dec 17, 2024
3d561d6
Include Feedback
mmailaender Dec 17, 2024
be67bc7
Addressed feedback
mmailaender Dec 17, 2024
60b90ff
Add closing quote
mmailaender Dec 17, 2024
ee08bcb
Add support messanger on the landing page
mmailaender Dec 17, 2024
3553583
Remove crisp
mmailaender Dec 17, 2024
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
13 changes: 5 additions & 8 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions sites/next.skeleton.dev/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"nanostores": "^0.11.3",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"sharp": "^0.33.5",
"react-hot-toast": "^2.4.1",
"svelte": "^5.6.2",
"svelte-check": "^4.1.1",
Expand Down
113 changes: 113 additions & 0 deletions sites/next.skeleton.dev/src/components/docs/FigmaBuyNow.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
import { Check as IconCheck } from 'lucide-react';
---

<!-- Load the Polar checkout script -->
<script src="https://cdn.jsdelivr.net/npm/@polar-sh/[email protected]/dist/embed.global.js" defer data-auto-init></script>

<script>
const htmlElement = document.documentElement;

const buyButtons = document.querySelectorAll('[data-polar-checkout]');

/**
* Updates the theme of the buy buttons based on the presence of the 'dark' class on the HTML element
*/
function updateTheme() {
const theme = htmlElement.classList.contains('dark') ? 'dark' : 'light';

buyButtons.forEach((button) => {
button.setAttribute('data-polar-checkout-theme', theme);
});
}

// Initial update of the theme
updateTheme();

// Create a MutationObserver to observe changes to the class attribute of the HTML element
new MutationObserver(() => {
updateTheme();
}).observe(htmlElement, {
// Observe changes to attributes
attributes: true,
// Only observe changes to the class attribute
attributeFilter: ['class']
});
</script>

<div class="flex flex-col bg-transparent rounded-container border-[1px] border-surface-200-800 shadow-lg overflow-hidden">
<div class="flex flex-col p-6 w-full">
<span class="text-xl font-semibold h-full pb-6">Figma UI Kit for Skeleton includes:</span>
endigo9740 marked this conversation as resolved.
Show resolved Hide resolved
<div class="flex flex-col gap-3">
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
<IconCheck size="12" />
</div>
<p>Figma Skeleton v3 Components library</p>
</div>
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure to change CTA buttons to preset-filled

<IconCheck size="12" />
</div>
<p>Lucide Icons</p>
</div>
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
<IconCheck size="12" />
</div>
<p>Dark / Light Support</p>
</div>
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
<IconCheck size="12" />
</div>
<p>Custom Theme Support</p>
</div>
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
<IconCheck size="12" />
</div>
<p>Figma Plugin to import your custom Theme</p>
</div>
<div class="flex flex-row items-center gap-3">
<div class="flex w-5 h-5 preset-tonal-primary rounded-full justify-center items-center">
<IconCheck size="12" />
</div>
<p>Tutorials</p>
</div>
</div>
</div>
<div class="flex flex-col md:flex-row bg-transparent w-full border-t border-surface-200-800">
<div class="flex flex-col gap-1 p-6 border-r md:border-t-0 border-b md:border-b-0 border-surface-200-800 w-full">
<span class="text-lg font-semibold"><span class="text-surface-600-400">License for</span> 1 person</span>
<div class="flex flex-col h-full pt-12">
<div class="flex flex-row gap-1 items-end pb-4">
<span class="text-4xl font-semibold">$109</span>
<span class="opacity-60">+1 year of updates </span>
</div>
<a
href="https://buy.polar.sh/polar_cl_4Wd2CxwXfx-g5z-87D2PNRkdamIiohCLnxH3UqaAqGA"
data-polar-checkout
data-polar-checkout-theme="dark"
class="btn btn-lg self-end preset-filled flex items-center gap-2 w-full">Buy</a
>
</div>
</div>
<div class="flex flex-col gap-1 p-6 w-full">
<span class="text-lg font-semibold"><span class="text-surface-600-400">License for</span> 25 people</span>

<div class="flex flex-col h-full pt-12">
<div class="flex flex-row gap-1 items-end pb-4">
<span class="text-4xl font-semibold">$219</span>
<span class="opacity-60">+1 year of updates </span>
</div>
<a
href="https://buy.polar.sh/polar_cl_vLLsRrjP5rIuLgp6Loez6lPjyg1vrAhH435-MVhIpIk"
data-polar-checkout
data-polar-checkout-theme="dark"
class="btn btn-lg self-end preset-filled flex items-center gap-2 w-full">Buy</a
>
</div>
</div>
</div>
</div>
4 changes: 2 additions & 2 deletions sites/next.skeleton.dev/src/components/docs/Header.astro
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import Navigation from '@components/docs/Navigation.astro';
const coreLinks = [
{ href: '/docs/get-started/introduction', label: 'Docs', target: '_self' },
{ href: '/news', label: 'News', target: '_self' },
{ href: 'https://themes.skeleton.dev/', label: 'Themes', target: '_blank' }
// { href: '/figma', label: 'Figma', target: '_self' }
{ href: 'https://themes.skeleton.dev/', label: 'Themes', target: '_blank' },
{ href: '/figma', label: 'Figma', target: '_self' }
];
---

Expand Down
5 changes: 5 additions & 0 deletions sites/next.skeleton.dev/src/components/docs/HideHeader.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<style is:global>
header[data-pagefind-body] {
display: none;
}
</style>
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const { step } = Astro.props;
<div class="type-scale-2 preset-filled-surface-200-800 -ml-4 flex size-7 items-center justify-center rounded-full">
{step !== 'check' ? step : <Check size={16} />}
</div>
<article class="[&>.h2]:!type-scale-4 space-y-4">
<article class="[&>.h2]:!type-scale-4 [&>.h3]:!type-scale-4 space-y-4">
<slot />
</article>
</div>
26 changes: 0 additions & 26 deletions sites/next.skeleton.dev/src/content/docs/get-started/figma.mdx

This file was deleted.

36 changes: 36 additions & 0 deletions sites/next.skeleton.dev/src/content/docs/guides/figma.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: '@layouts/LayoutDoc.astro'
title: Figma UI kit
description: Welcome to the Skeleton Figma Design System Tutorials!
order: 60
---

export const components = componentSet;

import FigmaBuyNow from '@components/docs/FigmaBuyNow.astro';
import NavGrid from '@components/docs/NavGrid.astro';

import { Image } from 'astro:assets';
import ImgHero from '@images/get-started/figma/hero.webp';
import ImgComponents from '@images/get-started/figma/components.webp';
import ImgPlugin from '@images/get-started/figma/plugin.webp';
import ImgTutorial from '@images/get-started/figma/tutorials.webp';
import ImgKit from '@images/get-started/figma/ui-kit.webp';
import { Clock3 } from 'lucide-react';
import { Shapes } from 'lucide-react';
import { SwatchBook } from 'lucide-react';

<p class="type-scale-5">Explore step-by-step guides to unlock the full potential of Skeleton in your design workflow. Whether you're setting up for the first time or mastering advanced features, these tutorials will guide you every step of the way.</p>

Discover all the benefits of Skeleton Figma UI library:
<figure class="card-filled-enhanced flex justify-center p-8">
<a
class="btn preset-filled"
href="/figma#get-access"
target="_blank"
>
Get the Figma UI Kit &rarr;
</a>
</figure>

<NavGrid collection="docs" path="figma/" classes="md:grid-cols-1" />
111 changes: 111 additions & 0 deletions sites/next.skeleton.dev/src/content/docs/guides/figma/chapter-1.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
layout: '@layouts/LayoutDoc.astro'
title: 1 - Setup & Usage
description: Get Started with Skeleton.
order: 0
---

export const components = componentSet;

import Process from '@components/docs/Process.astro';
import ProcessStep from '@components/docs/ProcessStep.astro';
import NavGrid from '@components/docs/NavGrid.astro';

import { Image } from 'astro:assets';
import { BookOpen } from 'lucide-svelte';
import SvgSkeleton from '@images/tutorials/figma/skeletonFileIcon.svg';
import ImgCreateNewProject from '@images/tutorials/figma/chapter-1/01_createNewProject.webp';
import ImgImportProject from '@images/tutorials/figma/chapter-1/02_importProject.webp';
import ImgPublish from '@images/tutorials/figma/chapter-1/03_publish.webp';
import ImgCreateNewFile from '@images/tutorials/figma/chapter-1/04_createNewFile.webp';
import ImgSelectLibrary from '@images/tutorials/figma/chapter-1/05_selectLibrary.webp';
import ImgUseLibrary from '@images/tutorials/figma/chapter-1/06_useLibrary.webp';

---

## How to Install the Figma Library

For best results, a <a href="https://www.figma.com/pricing/#figma" class="chip preset-filled mx-1" target="_blank">Figma Professional Team Plan</a> (or higher) is recommended.

<Process>
<ProcessStep step="1">
### Purchase the Figma Asset

<div class="card-enhanced border-[1px] border-surface-200-800 space-y-2 p-4 md:p-8 flex flex-row justify-between items-center">
<div className="flex flex-row gap-4 items-center">
<Image src={SvgSkeleton} class="rounded-container" alt="Skeleton" />
<div className="flex flex-col gap-1">
<h6 className="h6">Skeleton Figma Design System</h6>
<p>Complete set of themed components for Skeleton v3</p>
</div>
</div>
<a href="https://polar.sh/skeleton-kit/" type="button" class="btn preset-filled-primary-500" target="_blank">Purchase</a>
</div>
</ProcessStep>

<ProcessStep step="2">
### Create a New Project

In Figma, go to `Home`¹ and select `All projects`² from the left sidebar². On the right side, click `+ Project`³ and name the project `Libraries`⁴.

<Image src={ImgCreateNewProject} class="rounded-container" alt="Create New Project" />
</ProcessStep>

<ProcessStep step="3">
### Import Skeleton Design System

From the project page, click `Create new` in the top-right corner⁵ and select `Import`⁶. Then, choose `Import from computer`⁷ and select the Skeleton Figma file.

<Image src={ImgImportProject} class="rounded-container" alt="Import Project" />
</ProcessStep>

<ProcessStep step="4">
### Publish Skeleton Figma Library

To use the library across all Figma files, it must be published.

Double-click the Skeleton Library to open it. At the top left, next to the library file name, click the chevron `v`⁸ and select `Publish library…`⁹. In the modal, click `Publish`¹⁰ and wait for the library to finish publishing.

<Image src={ImgPublish} class="rounded-container" alt="Publish" />

Once published, you can access the Skeleton Figma Library in any of your projects.
</ProcessStep>
</Process>

---

## How to Use the Figma Library

<Process>
<ProcessStep step="1">
### Open or Create a Project to Use the Library

Open an existing project, or create a new one by clicking `+ Create new`¹ and selecting `Design file`².

<Image src={ImgCreateNewFile} class="rounded-container" alt="Create New File" />
</ProcessStep>

<ProcessStep step="2">
### Add the Library to Your Project

In the left sidebar, click `Assets`³, then click the <span class="badge-icon preset-filled"><BookOpen size={16} /></span> ⁴ icon. A modal will appear with the `Libraries` tab active. Search for `skeleton`⁵ and click `Add to file`⁶.

The library is now added to your file, and its assets are ready for use.

<Image src={ImgSelectLibrary} class="rounded-container" alt="Select Library" />
</ProcessStep>

<ProcessStep step="3">
### Use Assets (Components)

You can now access the Skeleton Design library. In the `Assets` tab, you’ll see a list of Skeleton Components. Drag components onto the canvas or search for specific ones.

<Image src={ImgUseLibrary} class="rounded-container" alt="Use Library" />
</ProcessStep>
</Process>

---

## Guides

<NavGrid collection="docs" path="figma/" classes="md:grid-cols-1" />
Loading
Loading