{"id":43916831,"url":"https://github.com/zooniverse/markdownz","last_synced_at":"2026-02-06T21:34:48.329Z","repository":{"id":35845359,"uuid":"40129109","full_name":"zooniverse/markdownz","owner":"zooniverse","description":"Markdown viewer and editor for the zooniverse","archived":false,"fork":false,"pushed_at":"2025-09-12T14:15:18.000Z","size":1483,"stargazers_count":2,"open_issues_count":11,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-11-14T07:23:45.737Z","etag":null,"topics":["utility"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zooniverse.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-08-03T14:25:26.000Z","updated_at":"2025-09-12T14:10:59.000Z","dependencies_parsed_at":"2023-02-12T22:16:10.558Z","dependency_job_id":"257acd6f-43f9-40ab-8975-be936d920136","html_url":"https://github.com/zooniverse/markdownz","commit_stats":{"total_commits":288,"total_committers":25,"mean_commits":11.52,"dds":0.75,"last_synced_commit":"4d6e454d1e5dbf61dfe7ebcf672ca9f99238b60a"},"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"purl":"pkg:github/zooniverse/markdownz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zooniverse%2Fmarkdownz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zooniverse%2Fmarkdownz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zooniverse%2Fmarkdownz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zooniverse%2Fmarkdownz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zooniverse","download_url":"https://codeload.github.com/zooniverse/markdownz/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zooniverse%2Fmarkdownz/sbom","scorecard":{"id":1237558,"data":{"date":"2025-08-18","repo":{"name":"github.com/zooniverse/markdownz","commit":"8dfaf72d431885de0fd7dc51a6c04b5bbb764cd8"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":3.9,"checks":[{"name":"Code-Review","score":2,"reason":"Found 6/22 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/run-tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/run-tests.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/zooniverse/markdownz/run-tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/run-tests.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/zooniverse/markdownz/run-tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/zooniverse/markdownz/run-tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/run-tests.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/zooniverse/markdownz/run-tests.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-09-12T16:12:46.887Z","repository_id":35845359,"created_at":"2025-09-12T16:12:46.897Z","updated_at":"2025-09-12T16:12:46.897Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29177554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T20:14:21.878Z","status":"ssl_error","status_checked_at":"2026-02-06T20:14:21.443Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["utility"],"created_at":"2026-02-06T21:34:48.265Z","updated_at":"2026-02-06T21:34:48.322Z","avatar_url":"https://github.com/zooniverse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdownz [![Build Status](https://travis-ci.org/zooniverse/markdownz.svg?branch=master)](https://travis-ci.org/zooniverse/markdownz)\n\nMarkdown viewer, editor, and help components for the [Zooniverse](https://www.zooniverse.org). Requires React 16.8 or higher.\n\n## Usage\n\nAvailable on [npm](http://npmjs.com), include as a dependency using `npm install --save markdownz`\n\nThis package contains three publicly accessible components: a Markdown viewer and a Markdown editor for Zooniverse-flavored Markdown, and a MarkdownHelp component.\n\nViewer:\n\nParse markdown to HTML with `markdown-it`, then render the result as a React component tree with `rehype-react`.\n\n```jsx\nimport { Markdown } from 'markdownz';\n\n\u003cMarkdown\u003e{A String of `Markdown`}\u003c/Markdown\u003e\n```\n\nDebug the viewer with the `debug` prop:\n\n```jsx\nimport { Markdown } from 'markdownz';\n\n\u003cMarkdown debug\u003e{A String of `Markdown`}\u003c/Markdown\u003e\n```\n\nEditor:\n\n```jsx\nimport { MarkdownEditor } from 'markdownz';\n\n\u003cMarkdownEditor rows={20} value=\"A String of `Markdown`\" onChange={this.handleMarkdownChange} /\u003e\n```\n\nHelp:\n\n```jsx\nimport { MarkdownHelp } from 'markdownz'\n\n\u003cMarkdownHelp talk={true} title={\u003ch1\u003eGuide to Markdown\u003c/h1\u003e} /\u003e\n```\n\nUtilities:\n\n```js\nimport { utils } from 'markdownz';\n\nconst content = `\n# A test document\n\nThis is a test [with a link](https://www.zooniverse.org).\n`\nconst html = utils.getHTML({ content });\n```\n\n```jsx\n// render HTML as JSX with utils.getComponentTree\nimport { utils } from 'markdownz';\nconst html = '\u003cp\u003eThis is a test paragraph, with \u003ca href=\"https://www.zooniverse.org\"\u003ea link.\u003c/a\u003e';\nconst markdownChildren = utils.getComponentTree({ html });\nreturn \u003cdiv\u003e{markdownChildren}\u003c/div\u003e;\n```\n\nHooks:\n\nThe `useMarkdownz` hook accepts the same props as the `Markdown` component. It returns the parsed content as a React component tree, which can be rendered as JSX or with `React.createElement`;\n\n```jsx\nimport { useMarkdownz } from 'markdownz';\n\nconst markdownChildren = useMarkdownz({ content: 'This is some markdown', debug: true });\nreturn \u003c\u003e{markdownChildren}\u003c/\u003e;\n```\n\n## Supported Properties\n\n### Viewer\n\n| property | default | effect |\n|----------|:-------:|--------|\n| children  | `null` | Markdown String to Render |\n| components | `null` | Rehype component mappings for the parsed output |\n| content | `''` | Markdown String to Render used if `this.props.children` is null |\n| debug | `false` | Return error messages, if true, for easier debugging |\n| settings | `{}` | Rehype settings for the parsed output |\n| tag | `div` | HTML tag to wrap markdown content with |\n| className | `''` | css classes for the element |\n| project | `null` | Panoptes project for links |\n| baseURI | 'null' | Set the base URI for building links |\n| inline | `false` | Toggles rendering between `markdownIt.render` and `markdownIt.renderInline`\n\n### Editor\n\n| property | default | effect |\n|----------|:-------:|--------|\n| name | `''` | Name for the `\u003ctextarea\u003e` in the Markdown editor |\n| value | `''` | Value of the `\u003ctextarea\u003e` in the Markdown editor |\n| placeholder | `''` | Placeholder text in the `\u003ctextarea\u003e` |\n| row | `5` | Height of the `\u003ctextarea\u003e` |\n| cols | `''` | `null` | Width of `\u003ctextarea\u003e` |\n| onChange | `NOOP` | Change listener |\n| project | `null` | Panoptes project for links |\n| baseURI | 'null' | Set the base URI for building links |\n| className | `''` | css classes for the element |\n| helpText | `null` | String or Component for custom help text for the editor |\n| onHelp   | `NOOP` | Function to run when help button is clicked |\n| previewing   | false | Toggle the editor's preview mode |\n\n### Help\n\n| property | default | effect |\n|----------|:-------:|--------|\n| talk | `false`| Toggle the inclusion of Talk-specific Markdown help content |\n| title | `\u003ch1 className=\"markdown-editor-title\"\u003eGuide to using Markdown\u003c/h1\u003e` | Title displayed at the top of the MarkdownHelp component |\n\n## Zooniverse-Flavoured Markdown\n\nWe use [markdown-it](https://github.com/markdown-it/markdown-it) for rendering Markdown and [twemoji](https://github.com/twitter/twemoji) for cross-browser emoji support.\n\nTODO: Document custom extensions.\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/zooniverse/markdownz/tree/master/CONTRIBUTING.md)\n\n## Publishing\n\n1. Create a new branch for the new version.\n2. Add the new version to the changelog with summary of changes.\n3. Update package.json and package-lock.json with the new version number (manually or with `npm --no-git-tag-version version [major|minor|patch]`).\n4. Commit and push the changes to GitHub. Create a pull request, optionally have it reviewed, and merge it.\n5. Using GitHub's web interface, create a new tag and release with the new version number and summary of changes.\n6. Pull the new version of the package locally.\n7. To clear any prior build (`./lib`), run tests, and create a fresh build, run `\"rm -rf lib \u0026\u0026 npm test \u0026\u0026 npm run build\"`.\n8. Run `npm publish --dry-run` to check that the package is ready to publish.\n9. Run `npm publish` to publish the new version to npm.\n\n## License\n\nCopyright 2015 by The Zooniverse. Licensed under the Apache Public License v2. See [LICENSE](https://github.com/zooniverse/markdownz/tree/master/LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzooniverse%2Fmarkdownz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzooniverse%2Fmarkdownz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzooniverse%2Fmarkdownz/lists"}