-
Notifications
You must be signed in to change notification settings - Fork 3k
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
docs(manual): write some content (introduction, observable, etc) #1390
Conversation
Depends on esdoc/esdoc#231 getting fixed. |
3ad5119
to
71d0c33
Compare
LGTM |
Alternatively, perhaps we can get @Widdershin to give us a workaround for esdoc vomiting on HTML comments? ... I have no idea what that would be... a config maybe? I dunno. I'm just trying to push the effort forward. |
Marking as blocked because of the esdoc issue. |
Indeed blocked. And no response from ESDoc side so far, perhaps I can try solving it myself and submitting a PR. The other option being turning off markdown-doctest for now. |
Not sure there's anything I can do on the markdown-doctest side (although suggestions are welcome). Without fully understanding the problem, I made a little fix. (esdoc Publisher/Builder/util.js) sanitizer: (tag) =>{
+ if (tag.match(/<!--.*-->/)) {
+ return tag;
+ }
+
const tagName = tag.match(/^<\/?(\w+)/)[1];
if (!availableTags.includes(tagName)) {
return escape(tag);
}
const sanitizedTag = tag.replace(/([\w\-]+)=(["'].*?["'])/g, (_, attr, val)=>{
if (!availableAttributes.includes(attr)) return '';
if (val.indexOf('javascript:') !== -1) return '';
return `${attr}=${val}`;
});
return sanitizedTag;
}, Would really love to avoid turning off markdown-doctest, especially while new docs are being written (would love to encourage people to write examples that actually run 😉) |
Me too. Was that fix for ESDoc? |
Yep! Publisher/Builder/util.js |
It would be awesome if you could see about getting that fix merged @staltz, I'm pretty overloaded right now so I'm not sure when I would have time |
Thanks for pointing me in the right direction @Widdershin :) |
71d0c33
to
11831a6
Compare
I submitted a PR to ESDoc: This PR is blocked until that is merged and a new version is released. |
Uhmm, I take that back. I'm baffled that the tests just passed in Travis :| |
…u colors Introduce informal quote style for spans, fix side bar menu colors and margins and paddings.
Such as grammar and the definition of Push vs Pull.
8f8878b
to
be106a3
Compare
Hello, this PR should now be unblocked |
355d46c
to
d64b1a4
Compare
Change looks good to me too. Since @Blesh already confirmed changes, I'll check this in later today. (give small time buffer just in case any other suggestion comes in) |
Yeah anyway it's just to kickstart the content, replacing |
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This PR has mostly text/content being added to the documentation.
To see this page live, open http://rxjs5-esdoc-manual-content-wip.surge.sh/.