Skip to content
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 configurations #826

Closed
8 tasks done
shuding opened this issue Sep 10, 2022 · 22 comments · Fixed by #734
Closed
8 tasks done

Rename configurations #826

shuding opened this issue Sep 10, 2022 · 22 comments · Fixed by #734
Assignees
Milestone

Comments

@shuding
Copy link
Owner

shuding commented Sep 10, 2022

I'm working on the docs and noticed some option names that can be improved for better consistency and accuracy. This will be another breaking change for v2, hopefully the last one.

  • banner.textbanner.content
  • footer.textfooter.content
  • editLink.texteditLink.content
  • feedback.linkfeedback.content
  • bodyExtraContentmain.extraContent (in the future we can configure the main content area here)
  • i18n.texti18n.name
  • projectChatchat
  • github → removed, use project.link
@shuding shuding added this to the 2.0 milestone Sep 10, 2022
@shuding shuding linked a pull request Sep 10, 2022 that will close this issue
@dimaMachina

This comment was marked as outdated.

@shuding

This comment was marked as outdated.

@shuding shuding self-assigned this Sep 10, 2022
@shuding shuding mentioned this issue Sep 10, 2022
@raproid

This comment was marked as off-topic.

@dimaMachina

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@dimaMachina

This comment was marked as outdated.

@shuding

This comment was marked as outdated.

@raproid

This comment was marked as off-topic.

@dimaMachina

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@dimaMachina

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@dimaMachina

This comment was marked as off-topic.

@raproid

This comment was marked as off-topic.

@champsupertramp

This comment was marked as off-topic.

@shuding shuding modified the milestones: 2.0, 3.0 Jan 20, 2023
@dimaMachina dimaMachina mentioned this issue Jan 28, 2023
20 tasks
@dimaMachina
Copy link
Collaborator

dimaMachina commented Jan 28, 2023

@shuding added new throughout for v3

footer: ReactNode | FC | { text: ReactNode | FC }
search: ReactNode | FC | { emptyResult: ..., error: ..., loading: ..., placeholder: ... }
toc: ReactNode | FC | { extraContent: ..., float: ..., title: ... }
editLink: ReactNode | FC | { text: ... }

@dimaMachina
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants