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

Make documentation compatible with Docusaurus #479

Open
claudiofahey opened this issue Mar 24, 2021 · 0 comments · May be fixed by #594
Open

Make documentation compatible with Docusaurus #479

claudiofahey opened this issue Mar 24, 2021 · 0 comments · May be fixed by #594
Assignees

Comments

@claudiofahey
Copy link

Is your feature request related to a problem? Please describe.
Docusaurus uses Markdown documentation with minor differences from mkdocs.

Describe the solution you'd like
Add Yaml front-matter. Move title from h1 header to front-matter title field. Add sidebars.js.

Describe alternatives you've considered
I considered run-time conversion but this does not appear to be worth the effort right now.

Additional context
See pravega/pravega#5889

@claudiofahey claudiofahey self-assigned this Mar 24, 2021
@derekm derekm linked a pull request Sep 24, 2021 that will close this issue
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.

1 participant