The Crystal programming language | http://crystal-lang.org | Fund Crystal's development: http://is.gd/X7PRtI | Docs: http://crystal-lang.org/docs/ | API: http://crystal-lang.org/api/
option b would be using mkdocs crystal extension
libraries like ones crystal runtime depends on, i.e. the dynamically linked ones
would be easier to just build on the mac
<riza> a classing example in the rails world is "medium" is the proper singular of "media" but nobody knows that
postmodern, yeah it probably doesn't, (assuming you tried it?) https://github.com/mkdocstrings/crystal supports it, though. what's your use case?
<postmodern> oprypin, unfortunately all of the markdown parsers (github, ruby's kramdowm, and crystal's) all disagree on how to escape
within a...or <code></code> element.
<postmodern> oprypin, this actually renders correctly locally using ruby yard+kramdown, but screws up on github: https://github.com/postmodern/chars.rb#features
<postmodern> oprypin, https://github.com/postmodern/chars.cr#features different issues here with escaping
inside of a `
<postmodern> i fear this is an unwinnable battle between the doc generator markdown implementation, and whatever werid version github is using to render markdown.
postmodern, prior to me abandoning the use of that generator, i always used to rip out that generated readme. nobody needs it there. and no, GitHub Markdown is most definitely not the weird one of the two.
i used to put a redirect to the main module's page.
and yes it's an unwinnable battle, but also a pointless battle
and yes it's an unwinnable battle, but also a pointless battle
GitHub has the best markdown generator I know. and crystal's one never really reached completeness
for me github just works
<postmodern> oprypin, github does not work for me. it's markdown rendering does not seem render
` or `\ or <code>`</code> correctly causing a cascading effect https://github.com/postmodern/chars.rb#features if i work around said issies, then i break commonmark or ruby's kramdown (which is pretty much bullet proof)
postmodern, anyway if you want good Markdown rendering and well integrated text+API docs, just use https://mkdocstrings.github.io/crystal/
<jhass[m]> maybe it likes it as an entity? &
<jhass[m]> `
<postmodern> see i want both proper documentation generation and a README which renders correctly on GitHub
<jhass[m]> probably not inside code tags
eh there are definitely differences in Markdown rendering but much much fewer of them
or i think this one is more convincing because it's more complicated html inside markdown
<postmodern> but "<code>
</code>" worked in kramdown, doesn't seem to work incrystal doc`, so that seems like an issue
again, crystal doc's Markdown is completely broken. that i would say is a waste of time
I've run into an issue where Crystal's Array#fill doesnt work the same as Ruby's (it doesnt allocate additional space, but throws an IndexError), but not sure if this is intentional.
a=[10]
a.fill(9,1,2)
Unhandled exception: Index out of bounds (IndexError)Ruby returns [10,9,9]
Unsure if the correct course of action is to file an issue, or manage this myself, though i havent seen a non-private method to increase capacity prior to running the #fill