Use Docusaurus #277
Merged
Use Docusaurus #277
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kazk
force-pushed
the
docusaurus
branch
3 times, most recently
from
9c2b101 to
2eeb50d
Compare
Closed
Member
Author
Contributor
|
Do you need any help here, migrating content or anything? |
Member
Author
|
Can you browse the preview and let me know if you find anything obviously broken? There are some things like sidebar labels/ordering and content structures that can be improved, but this PR should focus on the migration. Feel free to open issues about anything to improve, though, so we don't forget. Docusaurus has link checker, so all links within the docs should be valid. The empty link is no longer allowed, so I turned them into a code span for now. When this is deployed, I'll apply for DocSearch, and add the search bar after we get accepted. |
Member
Author
|
I think it's good enough to merge. We'll fix minor issues like titles as we go. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Decided to use Docusaurus because it's great out of the box, and allows extending Markdown with MDX like shortcodes in Zola. I still like Zola for simplicity, but it requires more setup, and I don't have the time. Full text search will be added using DocSearch.
The glossary page is not supported at the moment, but it will be.