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

v3 Docs: Site Design Refresh #3067

Open
11 of 14 tasks
endigo9740 opened this issue Dec 19, 2024 · 5 comments
Open
11 of 14 tasks

v3 Docs: Site Design Refresh #3067

endigo9740 opened this issue Dec 19, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@endigo9740
Copy link
Contributor

endigo9740 commented Dec 19, 2024

View the Legacy Ticket

As we get closer to the v3 release, I'd like to implement a final design refresh to the documentation site to establish both a more professional aesthetic and provide more a much more informative homepage. Our v2 homepage is a great reference, in that it walks you through the benefits of using Skeleton. This should do that, plus cover all additional features made possible with v3 (framework agnostic, etc).

Structure and Layout

  • Abstract link block styles to the global stylesheet (see the Plugin page for examples)
  • Updated <Preview> component to support dynamic tabs for preview|code|codeReact|codeSvelte
  • Implement Lightswitch and Theme Picker in mobile navigation
  • Preserve scroll position for Docs sidebar
  • Highlight the active navigation link
  • Smoother theme transitions using transition-all ONLY during transition
  • Improve the site layout; ensure it's fully responsive

Homepage Redesign

General Design Updates

  • Implement semantic typography styles
  • Consider Astro view transitions
  • Update app header bar
    • Convert to React component
    • Update various popover menus
@endigo9740 endigo9740 added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 19, 2024
@endigo9740 endigo9740 added this to the v3.0 (Next) milestone Dec 19, 2024
@endigo9740 endigo9740 self-assigned this Dec 19, 2024
@endigo9740 endigo9740 pinned this issue Jan 8, 2025
@endigo9740
Copy link
Contributor Author

Link block styles are now possible via the following HTML markup and classes:

<figure class="linker">
	<a
		class="linker-item"
		href="https://github.com/skeletonlabs/skeleton/blob/next/packages/skeleton/src/plugin/base/core.css"
		target="_blank"
	>
		View Base Styles
	</a>
</figure>

@endigo9740
Copy link
Contributor Author

endigo9740 commented Jan 10, 2025

The <Preview> component can now dynamically up to four tabs:

  • preview - the visual preview of the feature
  • code - the generic code block
  • codeReact - same as code, but listed under a React tab
  • codeSvelte - same as code, but listed under a Svelte tab.

If you mix code + one of the framework tabs, it'll rename from "Code" -> "Generic". Use this for Astro, Typescript, or vanilla JS examples.

Additionally the Preview tab is now optional as well. If you don't include it, just make sure to set selected="codeReact" or similar to denote the first active tab.

Screenshot 2025-01-10 at 3 22 59 PM

This is currently visible under the Cookbook Stepper and Chat recipe pages.

@endigo9740
Copy link
Contributor Author

Per the PR linked above, a number of structural improvements have now been deployed to the live site.

@phamduylong
Copy link
Contributor

phamduylong commented Jan 21, 2025

SvelteKit: Repo - Stackblitz REPL

Next.js: Repo - Stackblitz REPL

@phamduylong
Copy link
Contributor

Might be worth mentioning here, but heaps of our doc pages are lacking a title. At least those under components and integrations

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants