https://github.com/bearstudio/typed-mdx
Validate and type you MDX Frontmatter
https://github.com/bearstudio/typed-mdx
collection content mdx typescript zod
Last synced: 17 days ago
JSON representation
Validate and type you MDX Frontmatter
- Host: GitHub
- URL: https://github.com/bearstudio/typed-mdx
- Owner: BearStudio
- License: mit
- Created: 2024-01-04T13:31:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-17T12:32:29.000Z (11 months ago)
- Last Synced: 2024-07-18T10:55:30.330Z (11 months ago)
- Topics: collection, content, mdx, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 188 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typed MDX
Monorepo for the `typed-mdx` package.
## What's inside?
This monorepo is using Turborepo and includes the following packages/apps:
### Apps and Packages
- `docs`: a [Next.js](https://nextjs.org/) app for the documentation part
- `web`: another [Next.js](https://nextjs.org/) app for the example part
- `@repo/typed-mdx`: the main typed-mdx packages
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
### Build
To build all apps and packages, run the following command:
```
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```
pnpm dev
```
## Useful Links
Learn more about the power of Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)