Skip to content

Commit

Permalink
Merge pull request #13 from HiDeoo/hd-docs-improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
HiDeoo committed Jun 24, 2024
2 parents 1f07fa2 + 92b3eda commit db49157
Show file tree
Hide file tree
Showing 15 changed files with 861 additions and 907 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

## Documentation

Run the documentation locally using your favorite package manager, e.g. with [pnpm](https://pnpm.io):
Run the documentation locally using [pnpm](https://pnpm.io):

```shell
pnpm run dev
Expand Down
7 changes: 7 additions & 0 deletions docs/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ export default defineConfig({
{ label: 'Customization', link: '/customization/' },
],
},
{
label: 'Resources',
items: [
{ label: 'Showcase', link: '/resources/showcase/' },
{ label: 'Plugins and Tools', link: '/resources/starlight/' },
],
},
{ label: 'Demo', link: '/demo/' },
],
social: {
Expand Down
10 changes: 5 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
"lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
},
"dependencies": {
"@astrojs/starlight": "0.23.1",
"astro": "4.8.6",
"sharp": "0.33.2",
"starlight-image-zoom": "workspace:*",
"starlight-package-managers": "0.4.0"
"@astrojs/starlight": "0.24.4",
"@hideoo/starlight-plugins-docs-components": "^0.2.2",
"astro": "4.11.1",
"sharp": "^0.32.6",
"starlight-image-zoom": "workspace:*"
},
"engines": {
"node": ">=18"
Expand Down
Binary file added docs/src/assets/showcase/aoi.js.org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/docs.astronvim.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/docs.testomat.io.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase/wiki.atlauncher.com.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you don't have one yet, you can follow the ["Getting Started"](https://starli
## Installation

import { Steps } from '@astrojs/starlight/components'
import { PackageManagers } from 'starlight-package-managers'
import { PackageManagers } from '@hideoo/starlight-plugins-docs-components'

<Steps>

Expand Down
52 changes: 52 additions & 0 deletions docs/src/content/docs/resources/showcase.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Showcase
description: Discover Starlight project using the Starlight Image Zoom plugin.
---

import { ShowcaseIntro, Showcase } from '@hideoo/starlight-plugins-docs-components'

<ShowcaseIntro
cta="Have you built a documentation using Starlight Image Zoom?"
href="https://github.com/HiDeoo/starlight-image-zoom/edit/main/docs/src/content/docs/resources/showcase.mdx"
/>

## Sites

The Starlight Image Zoom plugin is already being used in production. These are some of the sites around the web:

<Showcase
entries={[
{
thumbnail: import('../../../assets/showcase/docs.astronvim.com.png'),
href: 'https://docs.astronvim.com/',
title: 'AstroNvim',
},
{
thumbnail: import('../../../assets/showcase/events-3bg.pages.dev.png'),
href: 'https://events-3bg.pages.dev/jotter/history/',
title: '👜 Bag of Tricks',
},
{
thumbnail: import('../../../assets/showcase/wiki.atlauncher.com.png'),
href: 'https://wiki.atlauncher.com/',
title: 'ATLauncher',
},
{
thumbnail: import('../../../assets/showcase/userdocs.github.io-qbittorrent-nox-static.png'),
href: 'https://userdocs.github.io/qbittorrent-nox-static/',
title: 'qbittorrent-nox-static',
},
{
thumbnail: import('../../../assets/showcase/aoi.js.org.png'),
href: 'https://aoi.js.org/',
title: 'aoi.js',
},
{
thumbnail: import('../../../assets/showcase/docs.testomat.io.png'),
href: 'https://docs.testomat.io/',
title: 'Testomatio',
},
]}
/>

See all the [public project repos using Starlight Image Zoom on GitHub](https://github.com/hideoo/starlight-image-zoom/network/dependents).
20 changes: 20 additions & 0 deletions docs/src/content/docs/resources/starlight.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Starlight Plugins and Tools
description: Discover other Starlight plugins, components and tools developed by HiDeoo.
---

import { ResourcesIntro, Resources } from '@hideoo/starlight-plugins-docs-components'

<ResourcesIntro />

## Plugins

<Resources type="plugins" />

## Components

<Resources type="components" />

## Tools

<Resources type="tools" />
2 changes: 1 addition & 1 deletion packages/starlight-image-zoom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-image-zoom.vercel.app/getting-started/).
Want to get started immediately? Check out the [getting started guide](https://starlight-image-zoom.vercel.app/getting-started/) or check out the [demo](https://starlight-image-zoom.vercel.app/demo/) to see the plugin in action.

## Features

Expand Down
4 changes: 2 additions & 2 deletions packages/starlight-image-zoom/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
"unist-util-visit-parents": "6.0.1"
},
"devDependencies": {
"@astrojs/starlight": "0.23.1",
"@astrojs/starlight": "0.24.4",
"@playwright/test": "1.42.1",
"@types/hast": "3.0.4",
"astro": "4.8.6",
"astro": "4.11.1",
"mdast-util-mdx-jsx": "3.1.2"
},
"peerDependencies": {
Expand Down
Loading

0 comments on commit db49157

Please sign in to comment.