Skip to content
Merged
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
25 changes: 24 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
api-reference
!api-reference/meta.json
!api-reference/meta.json

# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production
.env.local

# macOS-specific files
.DS_Store
115 changes: 115 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
// @ts-check
import { defineConfig, passthroughImageService } from 'astro/config';
import starlight from '@astrojs/starlight';
import react from '@astrojs/react';
import AutoImport from 'astro-auto-import';
import starlightAutoSidebar from 'starlight-auto-sidebar'
import path from 'path';

// https://astro.build/config
export default defineConfig({
site: "https://developers.llamaindex.ai",
base: "/typescript/",
outDir: path.resolve('./dist/typescript/workflows/'),
integrations: [
starlight({
plugins: [starlightAutoSidebar()],
title: 'LlamaIndex TypeScript Workflows Documentation',
head: [
{
tag: 'script',
content: `
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != "dataLayer" ? "&l=" + l : "";
j.async = true;
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, "script", "dataLayer", "GTM-WWRFB36R");
`,
},
{
tag: 'script',
content: `
document.addEventListener("DOMContentLoaded", function () {
var script = document.createElement("script");
script.type = "module";
script.id = "runllm-widget-script"
script.src = "https://widget.runllm.com";
script.setAttribute("version", "stable");
script.setAttribute("crossorigin", "true");
script.setAttribute("runllm-keyboard-shortcut", "Mod+j");
script.setAttribute("runllm-name", "LlamaIndex");
script.setAttribute("runllm-position", "BOTTOM_RIGHT");
script.setAttribute("runllm-assistant-id", "209");
script.setAttribute("runllm-disable-ask-a-person", true);
script.setAttribute(
"runllm-slack-community-url",
"https://discord.com/invite/eN6D2HQ4aX"
);
script.async = true;
document.head.appendChild(script);
});
`
}
],
social: [
{
icon: 'twitter',
label: 'Twitter',
href: 'https://x.com/llama_index'
},
{
icon: 'linkedin',
label: 'LinkedIn',
href: 'https://www.linkedin.com/company/llamaindex'
},
{
icon: 'blueSky',
label: 'Bluesky',
href: 'https://bsky.app/profile/llamaindex.bsky.social'
},
{
icon: 'github',
label: 'GitHub',
href: 'https://github.com/run-llama/llama_index/'
}
],
logo: {
light: './src/assets/llamaindex-dark.svg',
dark: './src/assets/llamaindex-light.svg',
replacesTitle: true,
},
favicon: '/logo-dark.png',
components: {
SiteTitle: './src/components/SiteTitle.astro',
Header: './src/components/Header.astro',
},
sidebar: [
{
label: 'Workflows',
autogenerate: { directory: 'workflows', collapsed: true },
},
{
label: 'Workflows API Reference 🔗',
link: '/workflows-api-reference/'
},
],
}),
AutoImport({
imports: [
{
'@icons-pack/react-simple-icons': ['SiBun', 'SiCloudflareworkers', 'SiDeno', 'SiNodedotjs', 'SiTypescript', 'SiVite', 'SiNextdotjs', 'SiDiscord', 'SiGithub', 'SiNpm', 'SiX'],
'@astrojs/starlight/components': ['Card', 'CardGrid', 'LinkCard', 'Icon', 'Tabs', 'TabItem', 'Aside', 'LinkButton']
},
],
}),
react(),
],
image: {
service: passthroughImageService(),
}
});
9 changes: 8 additions & 1 deletion docs/biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@
"root": false,
"extends": "//",
"files": {
"includes": ["src/**", "tests/**"]
"includes": [
"src/**",
"tests/**",
"!src/components",
"!src/content",
"!src/pages",
"!src/content.config.ts"
]
},
"linter": {
"rules": {
Expand Down
33 changes: 32 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@
"packageManager": "pnpm@10.15.0",
"scripts": {
"test": "vitest run",
"test:watch": "vitest"
"test:watch": "vitest",
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"repository": {
"type": "git",
Expand All @@ -26,6 +31,32 @@
"url": "https://github.com/run-llama/workflows-ts/issues"
},
"homepage": "https://github.com/run-llama/workflows-ts/blob/main/examples/README.md",
"dependencies": {
"@astrojs/mdx": "^4.2.6",
"@astrojs/react": "^4.2.7",
"@astrojs/starlight": "^0.34.3",
"@icons-pack/react-simple-icons": "^12.8.0",
"@types/react": "^19.1.4",
"@types/react-dom": "^19.1.5",
"astro": "^5.6.1",
"astro-auto-import": "^0.4.4",
"astro-icon": "^1.1.5",
"cross-env": "^7.0.3",
"dotenv": "^16.4.5",
"fs-extra": "^11.3.0",
"fumadocs-typescript": "^4.0.6",
"fumadocs-ui": "^15.3.3",
"glob": "^11.0.2",
"js-yaml": "^4.1.0",
"marked": "^15.0.11",
"react": "^19.1.0",
"react-dom": "^19.1.0",
"sharp": "^0.32.5",
"starlight-auto-sidebar": "^0.1.2",
"typedoc": "^0.28.4",
"typedoc-plugin-markdown": "^4.6.3",
"typedoc-plugin-merge-modules": "^7.0.0"
},
"devDependencies": {
"@llamaindex/workflow-core": "workspace:*",
"@llamaindex/workflow-otel": "workspace:^",
Expand Down
22 changes: 22 additions & 0 deletions docs/src/assets/llamaindex-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading