-
-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename exports & cleanup #105
base: main
Are you sure you want to change the base?
Conversation
import { defineConfig } from 'flatbread'; | ||
import { sourceFilesystem } from '@flatbread/source-filesystem'; | ||
import { transformMarkdown } from '@flatbread/transformer-markdown'; | ||
import { transformYaml } from '@flatbread/transformer-yaml'; | ||
import { createSvImgField } from '@flatbread/resolver-svimg'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we rename this too? resolveSvimgField
?
@@ -44,8 +44,7 @@ | |||
}, | |||
"devDependencies": { | |||
"@ava/typescript": "3.0.1", | |||
"@nrwl/workspace": "14.4.3", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice!
pnpm i flatbread | ||
|
||
# these are your likely suspects, but other plugins might fit your use cases | ||
pnpm i flatbread @flatbread/transformer-markdown @flatbread/source-filesystem | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plugins provided | |
- Sources | |
- | |
- [@flatbread/source-filesystem](https://github.com/FlatbreadLabs/flatbread/tree/main/packages/source-filesystem) | |
- the basic file source, for reading files | |
> if you'd like to add your source here create a pr! | |
- Transformers | |
- | |
- [@flatbread/transformer-markdown](https://github.com/FlatbreadLabs/flatbread/tree/main/packages/transformer-markdown) | |
- transform markdown with optional grey matter header | |
- [@flatbread/transformer-yaml](https://github.com/FlatbreadLabs/flatbread/tree/main/packages/transformer-yaml) | |
- transform yaml | |
> if you'd like to add your transformer here submit a pr! | |
- Resolvers | |
- | |
- [@flatbread/resolver-svimg](https://github.com/FlatbreadLabs/flatbread/tree/main/packages/resolver-svimg) | |
- optimize images in style with svimg | |
> if you'd like to add your own resolver here submit a pr! |
@@ -31,35 +31,27 @@ | |||
"*.d.ts" | |||
], | |||
"dependencies": { | |||
"@apollo/utils.keyvaluecache": "^1.0.1", | |||
"@apollo/utils.keyvaluecache": "1.0.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should split out @flatbread/provider-apollo
in the future too
Summary of changes
flatbread
package. Thus, these will not be installed unless you actually need them.Closes #100
Closes #101
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Does this introduce any non-backwards compatible changes?
Does this include any user config changes?