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
Refactor markdown files #14287
base: master
Are you sure you want to change the base?
Refactor markdown files #14287
Conversation
First, an observation: This PR does not require a core dev to review it. I suggest the @minetest/docs team (or anyone trustworthy, really) be allowed to review this (and have their approval count).
I recently (regrettably) pushed such a change; I'll have to fix it (or you could fix it here too, if you want). This seems to not render correctly on https://api.minetest.net. I think we want to stick to plain Markdown, for now. |
That website uses MkDocs, which supports extensions. There are already a few extensions enabled here and after some searching I found https://pypi.org/project/markdown-gfm-admonition/, which enables Github admonition boxes. I personally haven't tried testing this extension (I am too busy), but it looks promising, to whoever may be able to try. |
@Zughy Whose opinion should I get on this? |
It was about the GH info boxes but I guess it's been solved |
@sfan5 Thank you so much for digging through this pull. I would never have the time or energy to do it myself, so help is always appreciated. I hope you agree with my changes. |
Should be fine, can you merge/rebase the last tiny change? |
Merge conflicts have been resolved. |
Ready for review
This is a better version of #13503, but without so much noise. Only markdown files (and worlds_here.txt) were changed.
This PR adds these things to the documentation:
{ min=3, max=5 }
->{min=3, max=5}
)id
instead ofID
)/README.md
as Github has a builtin oneTo do (preferably in a different PR, just putting it out there):
protocol.txt
Some people still use the plaintext version of the Lua API, so I tried to maintain readability while still simplifying things.