Gathering detailed insights and metrics for prosemirror-codemark
Gathering detailed insights and metrics for prosemirror-codemark
Installations
npm install prosemirror-codemarkReleases
12
0.16.18 InlineAction fixes and improvements
v0.16.18
Published on 06 Jun 2022
v0.15.0
v0.15.0
Published on 01 Dec 2021
v0.14.1
v0.14.1
Published on 30 Nov 2021
Image Upload Placenolder
v0.11.0
Published on 19 Oct 2021
Tables
v0.8.0
Published on 21 Sept 2021
⚙️ New way to do inline actions and suggestions
v0.6.0
Published on 01 Jun 2021
Developer
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
16.18.1
NPM Version
8.19.2
Statistics
292 Stars
1,616 Commits
32 Forks
11 Watching
8 Branches
18 Contributors
Updated on 27 Nov 2024
Languages
TypeScript (92.81%)
SCSS (2.97%)
HTML (2.53%)
JavaScript (1.64%)
CSS (0.06%)
Total Downloads
Cumulative downloads
Total Downloads
669,507
Last day
87.9%
4,752
Compared to previous day
Last week
95.2%
19,362
Compared to previous week
Last month
54.8%
50,032
Compared to previous month
Last year
36.7%
336,218
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
4
Dev Dependencies
24
@types/jest@types/prosemirror-schema-basiccopyfilescss-loadereslinteslint-config-curvenotehtml-webpack-pluginjestnpm-run-allprettierprosemirror-example-setupprosemirror-inputrulesprosemirror-modelprosemirror-schema-basicprosemirror-stateprosemirror-viewrimrafstyle-loaderts-jestts-loadertypescriptwebpackwebpack-cliwebpack-dev-server
Versions
@curvenote/editor
An interactive scientific editor built with ProseMirror, React and Redux - by Curvenote.
Why
We think that creating beautiful reactive documents and explorable explanations should be easy. Writing technical documents is hard enough already, and choosing to make that writing interactive is beyond the reach or time-commitment of most communicators.
We aim to lower the barriers to writing computational narratives. Today, narrative is often moved out of computational notebooks into static document creation tools (Microsoft Word, Google Docs, LaTeX, Slides/PPT).
We think this is for two reasons:
- The need for more expressive components, formatting or referencing.
- CommonMark markdown does not support, for example, citations, cross-references, and even simple formatting like callouts (see various alternatives below).
- To enable collaborators and reviewers who don't use these tools (e.g. when writing and reviewing papers & reports, slide decks, etc.)
- Writing often requires collaborators that may not be comfortable with some combination of the tools required for computational narratives (e.g. git, md, notebooks, javascript, etc.).
Goals
@curvenote/editor aims to bridge the gap between expressiveness and writing accessibility by developing a rich, WYSIWYG, collaborative editor with a focus on interactivity that integrates with LaTeX, various flavours of Markdown, and the Jupyter and Sphinx ecosystems.
Overlap with Curvenote
@curvenote/editor is the editor that is used in Curvenote, a scientific writing platform that connects to Jupyter.
Alternatives
There are many Markdown syntax variants and extensions (e.g. RMarkdown, MyST Markdown, idyll-lang, MDX) that add flavours (usually) on top of CommonMark to allow for more complex documents and various degrees of interactivity. These syntaxes or development environments are often beyond the reach of many contributors and collaborative editing and review is often difficult.
Interactivity
We think the best explanations are explorable and promote active reading, and would love to see this style of writing more widely adopted in scientific teaching, writing and education. To us, that means deep integrations with the Jupyter ecosystem and providing ways to support traditional export as well.
Scope of Repository
A WYSIWYG editor for technical content and documents (papers, reports, documentation, etc.), and support computational into the narrative (c.f. explorable explanations).
Specifically:
- A stand alone scientific editor that can be integrated into other applications, React will be supported first-class.
- Integration points for collaboration, citations, and interactivity/reactivity.
- Prosemirror plugins for technical writing, comments, etc.
Monorepo
The editor package is a monorepo that is built with turborepo. Included in this repository are:
@curvenote/schema- the schema for this editor, focused on interactive content, also deals with translation and export.prosemirror-autocomplete- A plugin for ProseMirror that adds triggers for#hashtags,@mentions,/menus, and other more complex autocompletions.prosemirror-codemark- A plugin for ProseMirror that handles manipulating and navigating inline code marks.
Related packages
prosemirror-docx- Export from a ProseMirror schema to Microsoft Word.sidenotes- Reactive placement of comments, with hooks for multiple inline references.@curvenote/article- CSS and styling components and document layout@curvenote/components- interactive widgets and web-components@curvenote/runtime- client-side reactivity built on redux
A collaborative, rich text editor for interactive technical & scientific content., implementing the MyST Markdown, and integrating with JupyterLab, JupyterBook and Sphinx. The project will enable a larger audience to create publication-quality, standards-friendly documents through Jupyter, without having to learn a new syntax.
Roadmap
We use this editor at Curvenote where we have worked on it for the last few years. We will continue to spin out useful plugins like prosemirror-autocomplete and prosemirror-codemark. If you would like to see something specific, open an issue or email, or try out the editor on Curvenote!
2022
- Improve Markdown, Word and LaTeX export
- Improve collaboration experience (cursors and highlights)
- Possibly move to yjs as the collaboration backend
- Improve configuration/extensibility
- Improve/documentation integration demos
- Improve math editor, adding a WYSIWYG math editor (likely as plugin)
Other ideas and plans
- Integrate as a JupyterLab extension (would love help!!)
- Integrate with ipywidgets (would love help!!)
- Integrate with thebe (would love help!!)
Getting Started
git clone git@github.com:curvenote/editor.git
cd editor
npm install
npm run start
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 3/29 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
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
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/curvenote/editor/test.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:22
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:35
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:52
- Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 8 are checked with a SAST tool
Reason
37 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-3wc5-fcw2-2329
- Warn: Project is vulnerable to: GHSA-64fm-8hw2-v72w
- Warn: Project is vulnerable to: GHSA-cvr6-37gx-v8wc
- Warn: Project is vulnerable to: GHSA-f98w-7cxr-ff2h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
2.6
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More