logo

Marked Documentation

Authors

Marked takes an encompassing approach to its community. As such, you can think of these as concentric circles, where each group encompasses the following groups.


Christopher Jeffrey
Original Author
Started the fire

Josh Bruce
Publisher
Release Wrangler; Humaning Helper; Heckler of Hypertext

Steven
Publisher
Release Wrangler; Dr. Docs; Open source, of course; GitHub Guru; Humaning Helper

Jamie Davis
Committer
Seeker of Security

Tony Brix
Publisher
Release Wrangler; Titan of the test harness; Dr. DevOps
 

Brandon der Blätter
Contributor
Curious Contributor

Carlos Valle
Contributor
Maker of the Marked mark from 2018 to present

Federico Soave
Contributor
Regent of the Regex; Master of Marked

Karen Yavine
Contributor
Snyk's Security Saint

Костя Третяк
Contributor

Tom Theisen
Contributor
Defibrillator

Mateus Craveiro
Contributor
Defibrillator

Publishers

Publishers are admins who also have the responsibility, privilege, and burden of publishing the new releases to NPM and performing outreach and external stakeholder communications. Further, when things go pear-shaped, they're the ones taking most of the heat. Finally, when things go well, they're the primary ones praising the contributors who made it possible.

(In other words, while Admins are focused primarily on the internal workings of the project, Publishers are focused on internal and external concerns.)

Should not exceed 2: Having more people with the authority to publish a release can quickly turn into a consensus seeking nightmare (design by committee). Having only one is preferred (Directly Responsible Individual); however, given the nature of the project and its history, having an immediate fallback, and a potential deep fallback (Original author) is probably a good idea.

Details on badges

Admins

Admins are committers who also have the responsibility, privilege, and burden of selecting committers and making sure the project itself runs smoothly, which includes community maintenance, governance, dispute resolution, and so on. (Letting the contributors easily enter into, and work within, the project to begin contributing, with as little friction as possible.)

Should not exceed 3: When there are too many people with the ability to resolve disputes, the dispute itself can quickly turn into a dispute amongst the admins themselves; therefore, we want this group to be small enough to commit to action and large enough to not put too much burden on one person. (Should ensure faster resolution and responsiveness.)

To be listed: Admins are usually selected from the pool of committers (or they volunteer, using the same process) who demonstrate good understanding of the marked culture, operations, and do their best to help new contributors get up to speed on how to contribute effectively to the project.

To be removed: You can remove yourself through the GitHub UI.

Details on badges

Committers

Committers are contributors who also have the responsibility, privilege, some might even say burden of being able to review and merge contributions (just usually not their own).

A note on "decision making authority". This is related to submitting PRs and the advice process. The person marked as having decision making authority over a certain area should be sought for advice in that area before committing to a course of action.

Should not exceed 5: For larger PRs affecting more of the codebase and, most likely, review by more people, we try to keep this pool small and responsive and let those with decision making authority have final say without negative repercussions from the other committers.

To be listed: Committers are usually selected (or they volunteer, using the same process) from contributors who enter the discussions regarding the future direction of Marked (maybe even doing informal reviews of contributions despite not being able to merge them yourself).

To be removed: You can remove yourself through the GitHub UI.

A note on volunteering:

  1. Please do not volunteer unless you believe you can demonstrate to your peers you can do the work required.
  2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, whether you able to really commit to it.
  3. Don't let the previous frighten you away, it can always be changed later by you or your peers.

Details on badges

Contributors

Contributors are users who submit a PR, Issue, or collaborate in making Marked a better product and experience for all the users.

To be listed: make a contribution and, if it has significant impact, the committers may be able to add you here.

To be removed: please let us know or submit a PR.

Details on badges

Users

Users are anyone using Marked in some fashion, without them, there's no reason for us to exist.

Individual or Organization Website Project Submitted by
MarkedJS https://marked.js.org https://github.com/markedjs/marked The marked committers

To be listed: All fields are optional. Contact any of the committers or, more timely, submit a pull request with the following (using the first row as an example):

  • Individual or Organization: The name you would like associated with the record.
  • Website: A URL to a standalone website for the project.
  • Project: A URL for the repository of the project using marked.
  • Submitted by: The name and optional honorifics for the person adding the listing.

To be removed: Same as above. Only instead of requesting addition request deletion or delete the row yourself.

Badges

Badges? You don't need no stinkin' badges.

Movie references aside. (It was either that or, "Let's play a game", but that would have been creepy…that's why it will most likely come later.)

Badges? If you want 'em, we got 'em, and here's how you get 'em (and…dramatic pause…why not two dramatic pauses for emphasis?… how they can be taken away).

  • Add the appropriate badge to the desired contributor in the desired column of this page, even if they're not listed here yet.
  • Submit a PR (we're big on PRs around here, if you haven't noticed, help us help you).
  • Follow the instructions for submitting a badge PR. (There are more details to find within. Come on. Everybody likes surprises, right? No? Actually, we just try to put documentation where it belongs, closer to the code and part of the sequence of events.)

Badges at play:

Curious Contributor
A contributor with less than one year on this page who is actively engaged in submitting PRs, Issues, making recommendations, sharing thoughts…without being too annoying about it (let's be clear, submitting 100 Issues recommending the Marked Committers send everyone candy is trying for the badge, not honestly earning it).
Dr. DevOps

Someone who understands and contributes to improving the developer experience and flow of Marked into the world.

"The main characteristic of the DevOps movement is to strongly advocate automation and monitoring at all steps of software construction, from integration, testing, releasing to deployment and infrastructure management. DevOps aims at shorter development cycles, increased deployment frequency, more dependable releases, in close alignment with business objectives." ~ Wikipedia
Dr. Docs
Someone who has contributed a great deal to the creation and maintenance of the non-code areas of marked.
Eye for the CLI
At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.
GitHub Guru
Someone who always seems to be able to tell you easier ways to do things with GitHub.
Humaning Helper
Someone who goes out of their way to help contributors feel welcomed and valued. Further, someone who takes the extra steps(s) necessary to help new contributors get up to speed. Finally, they maintain composure even in times of disagreement and dispute resolution.
Heckler of Hypertext
Someone who demonstrates an esoteric level of knowledge when it comes to HTML. In other words, someone who says things like, "Did you know most Markdown flavors don't have a way to render a description list (`dl`)? All the more reason Markdown `!==` HTML."
Markdown Maestro
You know that person who knows about way too many different flavors of Markdown? The one who maybe seems a little too obsessed with the possibilities of Markdown beyond HTML? Come on. You know who they are. Or, at least you could, if you give them this badge.
Master of Marked
Someone who demonstrates they know the ins and outs of the codebase for Marked.
Open source, of course
Someone who advocates for and has a proven understanding of how to operate within open source communities.
Regent of the Regex

Can you demonstrate you understand the following without Google and Stackoverflow?

/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/

Because this author can't yet. That's who gets these.

Seeker of Security
Someone who has demonstrated a high degree of expertise or authority when it comes to software security.
Titan of the Test Harness
Someone who demonstrates high-levels of understanding regarding Marked's test harness.
Totally Tron
Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).

Special badges that come with the job:

Defibrillator
A contributor who stepped up to help bring Marked back to life by contributing solutions to help Marked pass when compared against the CommonMark and GitHub Flavored Markdown specifications.
Maker of the Marked mark
This badge is given to the person or organization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.
Release Wrangler
This is a badge given to all Publishers.
Snyk's Security Saint
This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.