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

WIP - markdeep'ify sokol_gfx.h #326

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

nurpax
Copy link
Contributor

@nurpax nurpax commented Jun 20, 2020

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 everything text 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..

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.

None yet

1 participant