On GitHub, StackExchange/Stacks-Editor has picked up 442 stars, TypeScript. Stack Overflow's Combination Rich Text / Markdown Editor
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Classic 2 and beta Classic releases are not supported by Editor 1.x. Applications
using Classic 2 should install Editor with the ^0.15.0 version range instead of
^1.0.0 or latest.
Editor intentionally depends on stable Stacks Icons V6. npm installs it
automatically; a separate Icons installation or upgrade to V7 is not required.
Import via Modules or CommonJS
<div id="editor-container"></div>
import { StacksEditor } from "@stackoverflow/stacks-editor";
// don't forget to include the styles as well
import "@stackoverflow/stacks-editor/dist/styles.css";
// include the Classic styles as they're not included in the Editor styles
import "@stackoverflow/stacks/dist/css/stacks.css";
new StacksEditor(
document.querySelector("#editor-container"),
"*Your* **markdown** here"
);
Import via <script> tag
Load Classic CSS and Editor CSS separately. The Editor bundle includes the Stacks
JavaScript it uses; load Classic JavaScript separately only if your page needs it
for other Stacks components.
<!--include Stacks -->
<link rel="stylesheet" href="path/to/node_modules/@stackoverflow/stacks/dist/css/stacks.css" />
<!-- include the bundled styles -->
<link
rel="stylesheet"
href="path/to/node_modules/@stackoverflow/stacks-editor/dist/styles.css"
/>
<div id="editor-container"></div>
<!-- Optional: enables code-block syntax highlighting with Highlight.js 11 -->
<script src="https://unpkg.com/@highlightjs/cdn-assets@11/highlight.min.js"></script>
<!-- include the bundle -->
<script src="path/to/node_modules/@stackoverflow/stacks-editor/dist/app.bundle.js"></script>
<!-- initialize the editor -->
<script>
new window.stacksEditor.StacksEditor(
document.querySelector("#editor-container"),
"*Your* **markdown** here",
{}
);
</script>
Development
Install dependencies with npm i
Build and start using npm start
Point your browser to the address listed in the output - typically http://localhost:8080/
Run Tests
Use the current Node LTS release. Install dependencies with npm ci and the
browser binaries with npx playwright install before running browser tests.
Run all unit tests (no end-to-end tests) using
npm run test:unit
Run all end-to-end tests (written in Playwright) using
npm run test:e2e
End-to-end tests need to follow the convention of using someName.e2e.test.ts as their filename. They'll automatically get picked up by the test runner this way.
Verify the published package and release configuration using:
npm run test:package
npm run test:release-config
The package check builds an npm tarball, installs it in a temporary consumer,
type-checks the public imports, and bundles its JavaScript and CSS. It then
opens the consumer in Chromium and checks editing and menu styling. Consumer
installation may access npm; direct Classic, Icons, and Highlight.js versions
match the repository lockfile. A missing Chromium binary fails the check.
Menu end-to-end tests cover keyboard operation and layout in light, dark,
high-contrast, and dark high-contrast themes across all three browsers.
They save heading-menu.png review artifacts in test-results/. These are
not pixel-regression baselines or a complete accessibility audit.
Browser Bundle analysis
Generate a stats.json file for analysis using
npm run build:stats
You can upload your stats.json file here or here for visualization. See more resources here.
Documentation hosting
Documentation hostnames follow the Editor major version, not the Stacks
Classic major version:
Domain
Branch
Editor version
Classic compatibility
editor.stackoverflow.design
main
1.x
Classic 3
v0.editor.stackoverflow.design
v0
0.15.x
Classic 2
Netlify manages the build settings and the v0 branch subdomain. The v0 branch
supersedes the earlier v2 branch for legacy maintenance and documentation. Its
name reflects Editor's own major version; the old name referred to Classic 2.
The beta-host redirect is defined in netlify.toml. It redirects only
beta.editor.stackoverflow.design to the current host, preserving paths and
query parameters. It does not redirect the current site, legacy site, or deploy
previews.
To complete the beta-host cutover:
Deploy the redirect configuration from main and verify the current and v0
sites before changing domain assignments.
Remove beta from Netlify's branch subdomains, then add
beta.editor.stackoverflow.design as a production domain alias. The rules in
main do not apply while that hostname still serves the separate beta branch.
Verify HTTPS and permanent redirects for the root and demo routes, including
URLs with query parameters. Confirm that the destination editors still work.
Remove beta and v2 from the branch-deploy allowlist, retaining v0.
Branch-deploy settings are separate from Git branches; do not delete branches
as part of this hosting change.
Publishing
We use Changesets to publish to npm, create GitHub Releases, and update the changelog.
Add a changeset to pull requests that require a package release.
The release workflow creates and updates a release pull request against main while changesets are pending.
Merging the reviewed release pull request publishes the package under npm's latest tag and creates a GitHub Release.
The v0 branch is configured for Editor 0.15.x maintenance releases under the separate legacy-v0 npm tag, without replacing latest or creating GitHub Releases. That tag is created when a maintenance release is published; use an explicit 0.15.x version range until then.
The release job runs only after lint, unit, end-to-end, packed-package, and release-configuration tests pass.
Review the generated versions, dependency ranges, changelog, and package
contents before merging the release pull request. Its merge authorizes
publication; there is no additional manual approval step in the workflow.
When exiting prerelease mode, remove consumed changesets from both .changeset/
and .changeset/pre/. Changesets 3 reads the latter directory as release input,
so it must not be used to archive changesets from completed releases.
Continue using Conventional Commits for repository history.
TopGit's last sync did not record any GitHub topics for StackExchange/Stacks-Editor. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on StackExchange/Stacks-Editor?
The most recent commit recorded on StackExchange/Stacks-Editor was 12 days ago, based on the GitHub push timestamp. The repository has 62 forks — one of the better signals of community interest.
Is StackExchange/Stacks-Editor open source?
Yes — StackExchange/Stacks-Editor ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/StackExchange/Stacks-Editor.
What license does StackExchange/Stacks-Editor use?
StackExchange/Stacks-Editor is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where can I see StackExchange/Stacks-Editor in action?
The project maintains a homepage at https://editor.stackoverflow.design. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about StackExchange/Stacks-Editor?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/StackExchange/Stacks-Editor is the definitive source.
Read full README in the tab above.
Still deciding about Stacks-Editor?
One click hands the question to an AI along with this page — see what it says about Stacks-Editor.