Skip to content

Commit 25d44a2

Browse files
authored
docs: init fumadocs (#38)
1 parent f92daec commit 25d44a2

File tree

6 files changed

+77
-0
lines changed

6 files changed

+77
-0
lines changed

.github/workflows/release.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
concurrency: ${{ github.workflow }}-${{ github.ref }}
9+
10+
jobs:
11+
release:
12+
name: Release
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: pnpm/action-setup@v4
17+
- name: Setup Node.js 20
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: 22
21+
cache: "pnpm"
22+
- name: Install dependencies
23+
run: pnpm install
24+
- name: Create Release Pull Request
25+
uses: changesets/action@v1
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28+
- name: Create Release Pull Request or Publish to npm
29+
id: changesets
30+
uses: changesets/action@v1
31+
with:
32+
publish: pnpm publish
33+
env:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

docs/index.mdx

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: What is LlamaFlow
3+
description: LlamaFlow 🌊 is a simple, lightweight workflow engine, in TypeScript.
4+
---
5+
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
6+
7+
LlamaFlow is a simple, lightweight workflow engine, in TypeScript.
8+
It is designed to be easy to use and integrate with your existing applications.
9+
10+
## Features
11+
12+
- Minimal core API (<=2kb)
13+
- 100% Type safe
14+
- Event-driven, stream oriented programming
15+
16+
## Installation
17+
18+
<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
19+
```shell tab="npm"
20+
npm install @llama-flow/core
21+
```
22+
23+
```shell tab="yarn"
24+
yarn add @llama-flow/core
25+
```
26+
27+
```shell tab="pnpm"
28+
pnpm add @llama-flow/core
29+
```
30+
</Tabs>

docs/package.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "@llama-flow/docs",
3+
"version": "0.0.1",
4+
"files": [
5+
"**/*.md",
6+
"**/*.mdx"
7+
]
8+
}

packages/core/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
"dev": "tsup --watch",
7171
"test": "vitest run",
7272
"test:ui": "vitest --ui",
73+
"prepublish": "tsup",
7374
"prepublishOnly": "cp ../../README.md ./README.md"
7475
},
7576
"devDependencies": {

pnpm-lock.yaml

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pnpm-workspace.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ packages:
22
- "./demo"
33
- "./demo/cloudflare"
44
- "./demo/browser"
5+
- "./docs"
56
- "./packages/*"

0 commit comments

Comments
 (0)