Skip to content

add docs for workers - #1432

Merged
joshbruce merged 12 commits into
markedjs:masterfrom
UziTech:worker-docs
May 3, 2019
Merged

add docs for workers#1432
joshbruce merged 12 commits into
markedjs:masterfrom
UziTech:worker-docs

Conversation

@UziTech

@UziTechUziTech commented Mar 1, 2019

Copy link
Copy Markdown
Member

Description

Add examples of how to run marked in a worker on node and in a browser.
https://docs-4nj255ohp.now.sh/#/USING_ADVANCED.md#workers

fixes#1184

Contributor

  • no tests required for this PR.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

@UziTechUziTech added the category: docs Documentation changes label Mar 1, 2019
Comment threaddocs/USING_ADVANCED.md Outdated
Comment threaddocs/USING_ADVANCED.md Outdated
Comment threaddocs/USING_ADVANCED.md Outdated
Comment threaddocs/USING_ADVANCED.md Outdated
@styfle

Copy link
Copy Markdown
Member

There was one bug in the example that was mixing function keyword and arrow functions.

I think we should just use arrow functions for workers because its an advanced feature and so we can assume the reader understands ES6.

styfleand others added 3 commits March 2, 2019 15:04
Co-Authored-By: UziTech <tony@brix.ninja>
Co-Authored-By: UziTech <tony@brix.ninja>
Co-Authored-By: UziTech <tony@brix.ninja>

@styflestyfle left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💚

@UziTech

Copy link
Copy Markdown
MemberAuthor

Nice catch

@UziTechUziTech changed the title add docs for workers[WIP] add docs for workersMar 7, 2019
@UziTech

Copy link
Copy Markdown
MemberAuthor

wait to merge this until after worker_threads in node are stable

@UziTechUziTech changed the title [WIP] add docs for workersadd docs for workersApr 26, 2019
@UziTech

Copy link
Copy Markdown
MemberAuthor

I added notes about Worker Threads being experimental and Web Workers sending objects on postMessage instead of just the string.

https://docs-4nj255ohp.now.sh/#/USING_ADVANCED.md#workers

I think this should be good to merge.

Comment threaddocs/USING_ADVANCED.md Outdated
Co-Authored-By: UziTech <tony@brix.ninja>
@UziTech
UziTech requested review from davisjam and joshbruceMay 3, 2019 18:08
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: docsDocumentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Question: Markdown, storage and security

3 participants

@UziTech@styfle@joshbruce