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

Advanced mod guide #530

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

bitonality
Copy link
Contributor

@bitonality bitonality commented May 27, 2024

Clarifies #526
Fixes #525
Addresses some of the requested documentation in #513

@Buckminsterfullerene02
Copy link
Member

Buckminsterfullerene02 commented May 27, 2024

@bitonality we are using mdbook for docs which means that;

  • the new github markdown features like important, tip, caution etc. are not supported by it (as far as I know, I don't recall seeing it in their docs, but they do move fast so maybe they have it now). Otherwise I would've been using them a lot more before...
  • when adding new files, you also need to update the page tree in SUMMARY.md. it's pretty self explanatory how that works once you see it

For either of the above you can manually merge docs-export and docs folders in the repo and download mdbook.exe to put in there so you can run a local copy to see how your changes look in it.

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

Successfully merging this pull request may close these issues.

[Improvement] Increase flexibility of xmake target settings for mod authors.
2 participants