Skip to content

Commit 67d7f88

Browse files
docs: updated readme
1 parent 92ff97c commit 67d7f88

File tree

1 file changed

+28
-67
lines changed

1 file changed

+28
-67
lines changed

README.md

Lines changed: 28 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,45 @@
1-
# Turborepo starter
1+
# MDX.org.ai
22

3-
This Turborepo starter is maintained by the Turborepo core team.
3+
## [`mdxai`](./packages/mdxai) - Generate & Edit Markdown & MDX
44

5-
## Using this example
6-
7-
Run the following command:
8-
9-
```sh
10-
npx create-turbo@latest
5+
```bash
6+
mdxai generate 100 blog post titles about the future of work post-AGI
117
```
128

13-
## What's inside?
14-
15-
This Turborepo includes the following packages/apps:
16-
17-
### Apps and Packages
18-
19-
- `docs`: a [Next.js](https://nextjs.org/) app
20-
- `web`: another [Next.js](https://nextjs.org/) app
21-
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
22-
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
23-
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
24-
25-
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
9+
## [`mdxdb`](./packages/mdxdb) - Markdown/MDX Files as a Database
2610

27-
### Utilities
11+
```ts
12+
import { ai } from 'mdxai'
13+
import { db } from 'mdxdb'
2814

29-
This Turborepo has some additional tools already setup for you:
30-
31-
- [TypeScript](https://www.typescriptlang.org/) for static type checking
32-
- [ESLint](https://eslint.org/) for code linting
33-
- [Prettier](https://prettier.io) for code formatting
34-
35-
### Build
36-
37-
To build all apps and packages, run the following command:
15+
const count = 100
16+
const topic = 'the future of work post-AGI'
17+
const titles = await ai.list`${count} blog post titles about ${topic}`
3818

39-
```
40-
cd my-turborepo
41-
pnpm build
19+
for (const title of titles) {
20+
const post = await ai`Write a blog post about ${title}`
21+
await db.set(`blog/${title.replace(' ', '_')}`, post)
22+
}
4223
```
4324

44-
### Develop
25+
## [`mdxld`](./packages/mdxld) - Linked Data for Markdown & MDX
4526

46-
To develop all apps and packages, run the following command:
27+
## [`mdxe`](./packages/mdxe) - Build, Execute, Test, & Deploy Code in Markdown & MDX
4728

48-
```
49-
cd my-turborepo
50-
pnpm dev
51-
```
52-
53-
### Remote Caching
54-
55-
> [!TIP]
56-
> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
29+
## [`mdxui`](./packages/mdxui) - UI Component Library for MDX
5730

58-
Turborepo can use a technique known as [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
31+
All of the `mdxui` components are available automatically in `mdxe`
5932

60-
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
61-
62-
```
63-
cd my-turborepo
64-
npx turbo login
33+
```mdx
34+
<Hero
35+
headline='Bring your ideas to life with MDX'
36+
content='MDX combines unstructured content in Markdown, structured data in YAML, executable code, and UI components.'
37+
/>
6538
```
6639

67-
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
40+
The components can also be used in any React/Next.js application:
6841

69-
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
70-
71-
```
72-
npx turbo link
42+
```tsx
43+
// mdx-components.tsx
44+
export { useMDXComponents } from 'mdxui'
7345
```
74-
75-
## Useful Links
76-
77-
Learn more about the power of Turborepo:
78-
79-
- [Tasks](https://turborepo.com/docs/crafting-your-repository/running-tasks)
80-
- [Caching](https://turborepo.com/docs/crafting-your-repository/caching)
81-
- [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching)
82-
- [Filtering](https://turborepo.com/docs/crafting-your-repository/running-tasks#using-filters)
83-
- [Configuration Options](https://turborepo.com/docs/reference/configuration)
84-
- [CLI Usage](https://turborepo.com/docs/reference/command-line-reference)

0 commit comments

Comments
 (0)