Markdown api docs #150
Markdown api docs #150
Conversation
|
I really like the fact I can see this example on GH: https://github.com/qunitjs/api.qunitjs.com/blob/a473d76f19c278af29f069b40861231afebd68c2/assert/async.md |
|
I'm super excited for this! Also, looks like this will move us away from the jquery-wordpress setup (which I am excited for), does this mean we will be able to do some design updates? I've gotten feedback several times recently that the visual appearance of the documentation site is a put-off (because it looks outdated). |
Yes! In anyway, I'll start with the most simple implementation. I'm currently using some CSS I borrowed from http://opendesignkit.org/ and I'll try to get the pages done and loading. As soon as we have it, we can improve the docs more and more.
The docs will look crude now, but open for any improvement :) |
|
The md files for api are ready. I'll create index files for folders and start applying some style. |
|
This is basically ready. (moving the todo to the main post) cc @gnarf on the api.qunitjs.com, can you help me, please? |
|
to test for now: run a local |
|
@leobalter How can I help? |
|
@leobalter No worries! Feel free to ping me direct via email tomorrow if @gnarf is unavailable, I should be wfh and am happy to help. |
this can be removed later when we don't need the prefix anymore
|
For now: http://qunitjs.github.io/api |
QUnit/only.md
Outdated
| } | ||
| }); | ||
|
|
||
| test( "say", function( assert ) { |
There was a problem hiding this comment.
Would prefer this say QUnit.test unless a destructure is shown at the top of this sample.
assert/notPropEqual.md
Outdated
| Foo.prototype.bar = 'prototype'; | ||
|
|
||
| var foo = new Foo( 1, "2", [] ); | ||
| var bar = new Foo( "1", 2, {} ); |
config/QUnit.config.md
Outdated
|
|
||
| ### `QUnit.config.current` (object) | ||
|
|
||
| This object isn't actually a configuration property, but is listed here anyway, as its exported through `QUnit.config`. This gives you access to some QUnit internals at runtime. See below for an example. |
There was a problem hiding this comment.
s/as its exported/as it's exported
I assume this is a long-standing typo rather than anything introduced in this PR, but all the same...
config/QUnit.config.md
Outdated
|
|
||
| Defines the HTML content to use in the fixture container which is reset at the start of each test. | ||
|
|
||
| By default QUnit will use whatever the starting content of `#quint-fixture` is as the fixture reset. If you do not want the fixture to be reset in between tests, set the value to `null`. |
|
Thanks @platinumazure, it should be fixed now. |
There was a problem hiding this comment.
WOW. 👏 I don't know if I'll have a chance for a deep dive, but I skimmed every file and this looks GREAT. The only question I have is whether you'd consider going even farther and moving it all into a /docs directory in the primary repository, which would allow QUnit PRs to form complete units encompassing both code and documentation changes. The work is already done here, so at this point it's just an organizational question—do we want a separate repository for documentation?
|
@gibson042 that's something I considered, and another reason to have md+jekyll as a +1 combo on GitHub. We'll need to figure out how to have it in sync with the published docs, thou. That's gonna be easy anyway. |
I'm currently using Jekyll to generate the files because of the simplicity and it's easy to use anything else later.
Everything is minimal and can have more work.
We need a few things: