Convert docs/ folder to mdBook #4684
Merged
Conversation
This file contains 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
AsparagusEduardo
approved these changes
Jun 3, 2024
AsparagusEduardo
added a commit
that referenced
this pull request
Jun 3, 2024
This reverts commit e925c51.
Merged
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.
This builds web documentation from the docs/ folder using mdBook, a language-agnostic documentation tool developed by the Rust programming language project.
Description
To avoid changing the existing directory structure, a Python preprocessor is used as a simple way to rewrite links. This is a slightly hacky solution, but seemed better than the alternatives.
mdBook only implements a subset of GitHub Flavored Markdown features, so the large number of autolinks in the changelogs needed to be replaced with standard Markdown bare links (Now done as part ofhttps://example.com→<https://example.com>).fix_links.py.The documentation generated by this PR is currently deployed at https://leo60228.github.io/pokeemerald.
Doing this was suggested by @AsparagusEduardo on Discord:
Note that porymap uses Sphinx rather than mdBook. From what I've seen, Sphinx is much less popular than mdBook for new projects.
Images
Discord contact info
leo60228