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

Update markdown description handling #65

Merged

Conversation

bourdakos1
Copy link
Member

@bourdakos1 bourdakos1 commented Nov 28, 2021

The goal of this PR is to generate a single markdown file for all static content. This will enable richer features for markdown descriptions and potential flexibility to allow users to supply their own markdown generator. This should also remove the react-markdown dependency as well as hardcoded remark/rehype plugins.

TODO:

  • Update docMetadata/versionsMetadata to apiMetadata
  • currentDocRoute -> currentApiRoute
  • sidebarName should come from the plugin and be unique
  • Metadata should include className for html tag (this was for versioned docs which is unneeded for our use case)
  • ApiItem shouldn't use docusaurus context
  • We should add a way to supply keywords and image to SEO
  • Ensure all PluginOptions are hooked up and work as expected
  • Update table margin styles

@bourdakos1 bourdakos1 marked this pull request as draft November 28, 2021 21:46
@bourdakos1 bourdakos1 marked this pull request as ready for review December 4, 2021 23:21
@bourdakos1 bourdakos1 merged commit 03716d4 into cloud-annotations:main Dec 4, 2021
@bourdakos1 bourdakos1 deleted the update-markdown-handling branch December 4, 2021 23:22
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.

None yet

1 participant