-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
[docs] ❗️BREAKING ❗️ various theme config options was renamed #721
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
🦋 Changeset detectedLatest commit: 323ada9 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
b1fb43b
to
0ff0bba
Compare
bbfe8a3
to
4c81433
Compare
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.
Thank you this is so much cleaner!
) * fix edit on github button for cases when filename named as `index` * fix typecheck * [docs] ❗️BREAKING ❗️ various theme config options was renamed (#721) * rename `meta.json` to `_meta.json` (#722) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` (#723) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist (#724) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist * apply review changes * rebase fixes
…719) * split css to `hamburger`/`scrollbar`/`typesetting-article` css files * fix edit on github button for cases when filename named as `index` (#720) * fix edit on github button for cases when filename named as `index` * fix typecheck * [docs] ❗️BREAKING ❗️ various theme config options was renamed (#721) * rename `meta.json` to `_meta.json` (#722) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` (#723) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist (#724) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist * apply review changes * rebase fixes * adjust active breadcrumb color (#725) * move `withLayout` logic directly in nextra loader (#726) * adjust active breadcrumb color * move `withLayout` logic directly in nextra loader * better loader types, add `MetaJsonFile`, `MdxFile`, `Folder` types, add tests for `next/context` (#731) * fix ci * fix callout shrinking from children content (#746)
* refactor toc, fix toc's styles on rtl, use `ref.current` instead `document.getElementsByClassName` * group both `mask-image` * fix search overlay styles on mobile * fix * split css to `hamburger`/`scrollbar`/`typesetting-article` css files (#719) * split css to `hamburger`/`scrollbar`/`typesetting-article` css files * fix edit on github button for cases when filename named as `index` (#720) * fix edit on github button for cases when filename named as `index` * fix typecheck * [docs] ❗️BREAKING ❗️ various theme config options was renamed (#721) * rename `meta.json` to `_meta.json` (#722) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` (#723) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist (#724) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component #564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist * apply review changes * rebase fixes * adjust active breadcrumb color (#725) * move `withLayout` logic directly in nextra loader (#726) * adjust active breadcrumb color * move `withLayout` logic directly in nextra loader * better loader types, add `MetaJsonFile`, `MdxFile`, `Folder` types, add tests for `next/context` (#731) * fix ci * fix callout shrinking from children content (#746) * Version Packages (beta) (#728) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix typecheck * fix typecheck * simplify Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Regarding this change: |
* refactor toc, fix toc's styles on rtl, use `ref.current` instead `document.getElementsByClassName` * group both `mask-image` * fix search overlay styles on mobile * fix * split css to `hamburger`/`scrollbar`/`typesetting-article` css files (shuding#719) * split css to `hamburger`/`scrollbar`/`typesetting-article` css files * fix edit on github button for cases when filename named as `index` (shuding#720) * fix edit on github button for cases when filename named as `index` * fix typecheck * [docs] ❗️BREAKING ❗️ various theme config options was renamed (shuding#721) * rename `meta.json` to `_meta.json` (shuding#722) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component shuding#564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` (shuding#723) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component shuding#564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist (shuding#724) * BREAKING! various theme config options was renamed * add new options `toc.component` to override toc component shuding#564 * rename editLink to editLinkText * add helpful console warnings * Update packages/nextra-theme-docs/src/contexts/config.tsx * Update packages/nextra-theme-docs/src/components/footer.tsx * fix project.link behaviour * small fix * fix * rename `meta.json` to `_meta.json` * update snapshots * rename `PageOpts.meta` to `PageOpts.frontMatter` * fix swr build * small fix * clicking on folder should navigate to first children if `index` page doesn't exist * apply review changes * rebase fixes * adjust active breadcrumb color (shuding#725) * move `withLayout` logic directly in nextra loader (shuding#726) * adjust active breadcrumb color * move `withLayout` logic directly in nextra loader * better loader types, add `MetaJsonFile`, `MdxFile`, `Folder` types, add tests for `next/context` (shuding#731) * fix ci * fix callout shrinking from children content (shuding#746) * Version Packages (beta) (shuding#728) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix typecheck * fix typecheck * simplify Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
fixes #676 #669
also, add new option
toc.component
to fix #564and fixes
project.link
behaviour #383nextra/packages/nextra-theme-docs/src/types.ts
Lines 15 to 82 in bbfe8a3
@shuding it was hard to implement without too monkey-business code for some options like
So I made the following
or more complex usage