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

Markdownify & upgrade to Docusaurus v3 #113

Merged
merged 3 commits into from
Dec 19, 2023

Conversation

TheRealPear
Copy link
Contributor

@TheRealPear TheRealPear commented Nov 19, 2023

I think this will be my largest pull request so far. Despite the numerous changes here, I have not added any new information pertaining to PGM. However, I did change some, such as map variants.

Here's a summary of my changes so far:

  • Upgraded to Docusaurus v3, which requires a minimum of NodeJS v18 now. I decided to use NodeJS v20 because it is the current LTS version at the moment. I've also updated the GitHub Actions workflow to use newer versions of the packages used for deploying, but I have not tested it.
  • Almost every tables have been converted to Markdown syntax. Some exceptions are Region Modifier Elements, Event Cause Filters, and Enchantments table because of their use of colSpan, which is not an option in standard Markdown. I also skipped over Material Finder table because I wasn't sure how it would affect the materials search script.
  • Rearranged tables CSS so it will work on both HTML and Markdown tables. However, I still have to use table-container div, otherwise the border-radius, box-shadow, and margin settings wouldn't apply.
  • Fixed buttons being uncentered in Downloads page, also enabled Community download button with a nightly.link download
  • Fixed Edit URL pointing to a invalid GitHub link.
  • Rewrote some paragraphs and corrected typo throughout the docs again.
  • Fixed React errors appearing in console.

@TheRealPear TheRealPear marked this pull request as draft November 20, 2023 16:12
@TheRealPear TheRealPear marked this pull request as ready for review December 1, 2023 21:05
@TheRealPear
Copy link
Contributor Author

However, I still have to use table-container div, otherwise the border-radius, box-shadow, and margin settings wouldn't apply.

I wanted to make a Docusaurus plugin where it would automatically wrap any Markdown tables with the div, but doing it is currently beyond my knowledge at the moment. I think the current workaround should be fine for now.

I also want to convert commonly used badges into a React component, but same issue as above. I will leave this for someone to do in a future pull request.

Signed-off-by: TheRealPear <20259871+TheRealPear@users.noreply.github.com>
Copy link
Collaborator

@CoWinkKeyDinkInc CoWinkKeyDinkInc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for simplifying all of these nasty HTML tables. Are you ready to have it merged?

docs/commands/main.mdx Outdated Show resolved Hide resolved
src/css/custom.css Show resolved Hide resolved
Co-authored-by: Patrick <CoWinkKeyDinkInc@users.noreply.github.com>
Signed-off-by: Pear <20259871+TheRealPear@users.noreply.github.com>
@TheRealPear
Copy link
Contributor Author

Thanks for your suggestions. It is ready for merging and we can resolve any new issues once I return from my vacation.

Signed-off-by: TheRealPear <20259871+TheRealPear@users.noreply.github.com>
@CoWinkKeyDinkInc CoWinkKeyDinkInc merged commit d0d382f into PGMDev:master Dec 19, 2023
3 checks passed
@TheRealPear TheRealPear deleted the 2k23-npm branch January 1, 2024 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants