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.

Sign up for GitHub

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

Jump to bottom

⚛️ Website - Documentation Page Layout #16

Open
1 of 5 tasks
Tracked by #2
lilingxi01 opened this issue May 27, 2022 · 1 comment
Open
1 of 5 tasks
Tracked by #2

⚛️ Website - Documentation Page Layout #16

lilingxi01 opened this issue May 27, 2022 · 1 comment
Labels
website
Milestone
0.1.0 - First Maj...

Comments

@lilingxi01
Copy link
Owner

lilingxi01 commented May 27, 2022 •
edited
Loading

Description

I am planning to built-in the documentation into the website directly by using MDX. So we do not need a separate documentation system and have a full power of customization.

Design / Solution

  • Embedding MDX.
  • Sidebar navigation.
  • Core typography (styles).
  • Codesandbox integration.
  • Report on GitHub button.

Additional Context

For the styling of core typography, we can refer to the documentation website of MUI or Radix UI.
@lilingxi01 lilingxi01 mentioned this issue May 27, 2022
Open
24 tasks
@lilingxi01 lilingxi01 changed the title ⚛️ Documentation Layout ⚛️ Website - Documentation Page Layout May 27, 2022
@lilingxi01 lilingxi01 added this to the 0.0.1 - Liftoff! milestone Jun 4, 2022
@lilingxi01
Copy link
Owner Author

For the first version, we only keep the home page little demo.
Will build a full doc in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
website
Projects
None yet
Milestone
0.1.0 - First Major Release
Development

No branches or pull requests
1 participant
@lilingxi01