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

plugin: Automatic MDX docs #10

Draft
wants to merge 46 commits into
base: with/green-stack
Choose a base branch
from
Draft

Conversation

codinsonn
Copy link
Contributor

@codinsonn codinsonn commented Aug 20, 2024

Plugin features when merged

  • Apply the changes from with/green-stack plugin branch (#9 Plugin: GREEN stack)
  • Apply the changes from with/mdx-docs-nextra plugin branch (#7 Plugin: MDX Nextra Docs)
  • Add .docs.tsx versions of form component intended specifically for interactive prop tables
  • Create the ComponentDocsContextManager component
  • Create the ComponentDocsPreview component
  • Create the ComponentDocsPropTable component
  • Create the ComponentDocs component that combines preview + props table
  • Figure out starting and example props based on prop schema
  • Sync component props state to the URL
  • Make preview table state resettable
  • Update to Nextra v3
  • Add generate-mdx-docs script to auto detect and build the related MDX files
  • Handle change handlers in ComponentDocs for interacting with the component itself

Preview

DocgenExample

Docs updated

  • Quickstart
  • Core Concepts
  • Project Structure
  • Single Sources of Truth

Building your app

  • Universal Routing
  • Write-once styling
  • Resolvers and APIs
  • Data Fetching
  • Form Management

Guides

  • Env Vars + App Config
  • Build and Deploy

Portability

  • Maximise Code Reuse
  • Workspace Drivers

Time Savers

  • Scripts and Automations
  • Code Generators
  • Git based Plugins

@codinsonn codinsonn self-assigned this Aug 20, 2024
Copy link

vercel bot commented Aug 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
universal-app-router ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 19, 2025 6:41pm
universal-base-starter-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 19, 2025 6:41pm

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 this pull request may close these issues.

1 participant