Skip to content

Commit

Permalink
feat: Small improvements to the docs frontpage. (#102)
Browse files Browse the repository at this point in the history
## Proposed changes

* Make the "Getting Started" link go to `/overview`
* Add links to github and npm
* Move around the logo and add a tagline.
* Turn on sitemap
* Enable "Edit on github" link

<img width="1487" alt="image"
src="https://github.com/user-attachments/assets/226adc58-121c-4044-af31-5d2d6bd6734f"
/>
  • Loading branch information
jmoseley authored Jan 14, 2025
1 parent 3e4194e commit 0a6eb8a
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 33 deletions.
14 changes: 7 additions & 7 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { defineConfig } from "astro/config";

// https://astro.build/config
export default defineConfig({
site: "https://gensx.dev",
integrations: [
tailwind(),
starlight({
Expand All @@ -24,10 +25,9 @@ export default defineConfig({
themes: ["light-plus", "dark-plus"],
useStarlightDarkModeSwitch: false,
},
// TODO: Enable the edit link when we have some content.
// editLink: {
// baseUrl: "https://github.com/cortexclick/gensx/edit/main/docs/",
// },
editLink: {
baseUrl: "https://github.com/cortexclick/gensx/edit/main/docs/",
},
customCss: ["./src/tailwind.css"],
sidebar: [
{
Expand Down Expand Up @@ -65,9 +65,9 @@ export default defineConfig({
applyBaseStyles: false,
}),
],
// adapter: cloudflare({
// imageService: "compile",
// }),
// adapter: cloudflare({
// imageService: "compile",
// }),
vite: {
ssr: {
external: ["node:buffer", "node:path", "node:url"],
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"@astrojs/tailwind": "^5.1.4",
"@cloudflare/workers-types": "^4.20241230.0",
"@types/node": "^20.17.11",
"sharp": "^0.33.5",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.2",
"wrangler": "^3.99.0"
Expand Down
1 change: 1 addition & 0 deletions docs/src/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 23 additions & 18 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,28 @@
title: "Declarative LLM workflows"
template: splash
hero:
title: |
<div class="flex justify-center md:justify-start">
<img src="/logo.svg" alt="&lt;GenSX /&gt;" class="w-auto h-auto max-w-[200px] md:max-w-[400px]" />
</div>
tagline: |
<div class="md:mt-8 md:inline-block md:border md:border-slate-200 md:dark:border-slate-800 md:rounded-lg md:p-8 md:bg-slate-50/50 md:dark:bg-slate-900/80 md:shadow-sm">
<div class="text-center md:text-left">Declarative LLM workflows</div>
<div class="mt-6 flex justify-center md:justify-start gap-4">
<a href="https://npmjs.com/package/gensx" class="inline-flex items-center justify-center no-underline bg-[#ffde59] hover:bg-[#e5c850] dark:bg-[#ffde59] dark:hover:bg-[#e5c850] text-black font-medium px-6 py-2.5 rounded-full text-sm transition-colors">Get started</a>
</div>
</div>
title: "Declarative LLM workflows"
tagline: "Create LLM workflows from components"
image:
html: |
<div class="fixed inset-0 z-[-1] overflow-hidden">
<div class="absolute inset-0" style="mask-image: radial-gradient(circle at center, black 40%, transparent 70%); -webkit-mask-image: radial-gradient(circle at center, black 40%, transparent 70%);">
<div class="absolute inset-0" style="background-image: radial-gradient(circle at center, rgba(100,100,100,0.3) 1px, transparent 1px); background-size: 20px 20px;"></div>
</div>
</div>
actions: []
alt: "<GenSX /> - Declarative LLM workflows"
file: "../../assets/logo.svg"
actions:
- text: "Get started"
icon: "right-arrow"
link: "/overview"
- text: "GitHub"
link: "https://github.com/cortexclick/gensx"
variant: "secondary"
icon: "github"
attrs:
target: "_blank"
rel: me
- text: "NPM"
link: "https://npmjs.com/package/gensx"
variant: "secondary"
icon: "seti:npm"
attrs:
target: "_blank"
rel: me
editUrl: false
---
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.

0 comments on commit 0a6eb8a

Please sign in to comment.