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.
A quick and dirty markdeep test for sokol_gfx.
Reasonably ok but should think what type of formatting to use. Code block highlighting is sort of all over the place, not sure why first lines of code blocks sometimes get bolded and the rest do not.
Also markdeep
is supposed to choose a non-highlighting formatter (e.g., plain text).. or so I thought. But it always autodetects the language and forces highlighting on. So I forced those sections to
text
. For the first pass, forcing everythingtext
might look better.But IMO the STEP BY STEP part would benefit from sort of of section titles. Like for example, I'd group buffer usage and updating under some sort of buffer section.
I didn't try to turn the rest of the header into an API ref. If markdown supports that, that'd be great. But IMO the introduction document is what I feel is more important than pure a API reference.
While markdown is sort of OK to read in ASCII, it won't be more readable than a pure ASCII .h file. You win some, you lose some..