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

docs: Add section explaining markdown options #175

Open
wolfiediscord opened this issue Feb 12, 2025 · 0 comments
Open

docs: Add section explaining markdown options #175

wolfiediscord opened this issue Feb 12, 2025 · 0 comments

Comments

@wolfiediscord
Copy link
Contributor

wolfiediscord commented Feb 12, 2025

Description

Currently, in the README file, there is no section that explains the different markdown options for notes, warnings, important, etc. While it seems self explanatory, new contributors must examine every page of documentation or dig into the code to see all available options, which can be discouraging or create badly formatted pages.

Potential Fixes

  • Add a section to the README.md that explains these options or links to a guide
  • Create a new file that explains these options and provides some general markdown instructions for new contributors

With these fixes, it would make contributing new games, (and potentially applications), much easier.

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

No branches or pull requests

1 participant