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

WIP: Feature/EN-688 markdown to custom component #93

Closed
wants to merge 17 commits into from

Conversation

m7kvqbe1
Copy link
Collaborator

@m7kvqbe1 m7kvqbe1 commented Jun 26, 2019

Related Jira issue:

https://rn-nelson.atlassian.net/browse/EN-688

Overview

Implement a pre-parser for the component library README.md files to convert MD into MDX.

Reason

The README.md files need to stay as pure markdown, but in order to display them on the docs-site some markdown structures need to be converted to their corresponding docs-site JSX representation (presentational components).

Work carried out

  • Implement pre-parser and translators (CodeHighlighter & DataTable)
  • Fix issues with Gatsby MDX parser errors (need to escape some prop values)
  • Implement transformTableData for DataTable translator
  • Generate code examples (need to transpile JSX - maybe use @babel/node CLI)
  • Pass code examples as tree of React nodes (use props.children for render)
  • Deal with yarn audit security error (marked ^0.6.2 required)

Screenshot

Screenshot 2019-06-26 at 13 24 17

Developer notes

There is a known issue with Yarn workspaces and resolutions: yarnpkg/yarn#5039

This is currently blocking me from dealing with the audit failure.

Potential solution: yarnpkg/yarn#6669 (comment)

@m7kvqbe1 m7kvqbe1 self-assigned this Jun 26, 2019
@m7kvqbe1 m7kvqbe1 changed the title Feature/EN-688 markdown to custom component WIP: Feature/EN-688 markdown to custom component Jun 26, 2019
@m7kvqbe1 m7kvqbe1 marked this pull request as ready for review June 26, 2019 14:40
@m7kvqbe1 m7kvqbe1 closed this Jul 9, 2019
@m7kvqbe1 m7kvqbe1 deleted the feature/markdown-to-custom-component branch January 18, 2022 11:50
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