{"id":17242800,"url":"https://github.com/imcuttle/detect-one-changed","last_synced_at":"2025-04-14T03:25:37.223Z","repository":{"id":45112960,"uuid":"155248922","full_name":"imcuttle/detect-one-changed","owner":"imcuttle","description":"Detect first changed html and markdown between old text and new","archived":false,"fork":false,"pushed_at":"2023-01-04T16:35:59.000Z","size":1963,"stargazers_count":5,"open_issues_count":21,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T02:33:59.191Z","etag":null,"topics":["diff","highlight","hmr","markdown","preview"],"latest_commit_sha":null,"homepage":"https://imcuttle.github.io/detect-one-changed/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imcuttle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-29T16:58:45.000Z","updated_at":"2024-05-11T06:03:45.000Z","dependencies_parsed_at":"2023-02-02T18:47:19.153Z","dependency_job_id":null,"html_url":"https://github.com/imcuttle/detect-one-changed","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdetect-one-changed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdetect-one-changed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdetect-one-changed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Fdetect-one-changed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imcuttle","download_url":"https://codeload.github.com/imcuttle/detect-one-changed/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248360212,"owners_count":21090665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["diff","highlight","hmr","markdown","preview"],"created_at":"2024-10-15T06:14:06.301Z","updated_at":"2025-04-14T03:25:37.201Z","avatar_url":"https://github.com/imcuttle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# detect-one-changed\n\n[![Build status](https://img.shields.io/travis/imcuttle/detect-one-changed/master.svg?style=flat-square)](https://travis-ci.org/imcuttle/detect-one-changed)\n[![Test coverage](https://img.shields.io/codecov/c/github/imcuttle/detect-one-changed.svg?style=flat-square)](https://codecov.io/github/imcuttle/detect-one-changed?branch=master)\n[![NPM version](https://img.shields.io/npm/v/detect-one-changed.svg?style=flat-square)](https://www.npmjs.com/package/detect-one-changed)\n[![NPM Downloads](https://img.shields.io/npm/dm/detect-one-changed.svg?style=flat-square\u0026maxAge=43200)](https://www.npmjs.com/package/detect-one-changed)\n[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n\n\u003e Detect first changed html and markdown between old text and the new\n\n![](https://i.loli.net/2018/10/28/5bd58a95c6b7d.gif)\n\n[Live Demo](https://imcuttle.github.io/detect-one-changed/)\n\n## Table of Contents\n\n\u003c!-- toc --\u003e\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [API](#api)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Authors](#authors)\n- [License](#license)\n\n\u003c!-- tocstop --\u003e\n\n## Installation\n\n```bash\nnpm install detect-one-changed\n# or use yarn\nyarn add detect-one-changed\n```\n\n## Usage\n\n### Use it as an package\n\n```javascript\nconst { detectMarkdown } = require('detect-one-changed')\n\ndetectMarkdown('abcd\\n\\n# old', 'abcd\\n\\n# new').text\n// =\u003e 'abcd\\n\\n\u003cp class=\"detected-updated\" style=\"\"\u003e\\n\\n# new\\n\\n\u003c/p\u003e\\n'\n```\n\n```javascript\nconst { detectMarkdown } = require('detect-one-changed')\nconst remark = require('remark')\nconst html = require('remark-html')\n\nremark()\n  .use(html)\n  .stringify(detectMarkdown('abcd\\n\\n# old', 'abcd\\n\\n# new', { wrapType: 'ast' }).ast)\n// =\u003e '\u003cp\u003eabcd\u003c/p\u003e\\n\u003ch1 class=\"detected-updated\"\u003enew\u003c/h1\u003e\\n'\n```\n\n```javascript\nconst { detectHtml } = require('detect-one-changed')\n\ndetectHtml('\u003cp\u003eold\u003c/p\u003e', '\u003cp class=\"new-cls\"\u003enew\u003c/p\u003e').text\n// =\u003e '\u003cp class=\"detected-updated new-cls\"\u003enew\u003c/p\u003e'\n```\n\n### Use it as webpack loader\n\nMore information please see [loader](./docs/loader.md)'s document and [webpack example](./examples/webpack)\n\n- Step one: (`webpack.config.js`)\n\n  ```javascript\n  // ...\n  devServer: {\n    hot: true\n  },\n  module: {\n    rules: [\n      {\n        test: /\\.md$/,\n        use: [\n          process.env.NODE_ENV !== 'production' \u0026\u0026 {\n            name: 'detect-one-changed/md-loader',\n            options: { returnType: 'text' }\n          }\n          // { name: 'some-md-to-html-loader' },\n        ].filter(Boolean)\n      }\n    ]\n  }\n  // ...\n  ```\n\n- Step two (set up HMR in browser)\n\n  ```javascript\n  function start() {\n    document.querySelector('.markdown-body').innerHTML = require('./path/to/some.md')\n  }\n\n  if (module.hot) {\n    module.hot.accept('./path/to/some.md', () =\u003e {\n      // Injects highlight css text in \u003cstyle/\u003e\n      require('!style-loader!css-loader!detect-one-changed/style.css')\n      start()\n\n      const node = document.querySelector('.markdown-body .detected-updated')\n      if (node) {\n        // Scroll to updated node\n        node.scrollIntoView({ behavior: 'smooth' })\n      }\n    })\n  }\n  ```\n\n- Step three\n\n  1. `npm install webpack webpack-dev-server -D`\n  2. `webpack-dev-server`\n\n### Use in [MDX](https://github.com/mdx-js/mdx)\n\n- `webpack.config.js`\n  ```javascript\n  ...\n    {\n      use: /\\.mdx?$/,\n      loaders: [\n        {\n          name: '@mdx-js/mdx-loader',\n          options: {\n            mdPlugin: [require('detect-one-changed/remark-plugin')]\n          }\n        }\n      ]\n    }\n  ```\n\n* `src/index.js` (entry)\n\n  ```javascript\n  import * as React from 'react'\n  import { render } from 'react-dom'\n\n  function start() {\n    const Markdown = require('./markdown.mdx').default\n    render(\u003cMarkdown /\u003e, document.querySelector('.markdown-body'))\n  }\n\n  start()\n\n  if (module.hot \u0026\u0026 process.env.NODE_ENV !== 'production') {\n    module.hot.accept(['./markdown.mdx'], () =\u003e {\n      require('!style-loader!css-loader!detect-one-changed/style.css')\n      start()\n\n      const node = document.querySelector('.detected-updated')\n      if (node) {\n        node.scrollIntoView({ behavior: 'smooth' })\n      }\n    })\n  }\n  ```\n\n## API\n\n[See API](./docs/api.md)\n\n## Related\n\n- [live-markd](https://github.com/imcuttle/live-markd) - 📝Github Favorite Markdown preview with live rendering \u0026 location and highlight changed block.\n\n## Contributing\n\n- Fork it!\n- Create your new branch:  \n  `git checkout -b feature-new` or `git checkout -b fix-which-bug`\n- Start your magic work now\n- Make sure npm test passes\n- Commit your changes:  \n  `git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`\n- Push to the branch: `git push`\n- Submit a pull request :)\n\n## Authors\n\nThis library is written and maintained by imcuttle, \u003ca href=\"mailto:moyuyc95@gmail.com\"\u003emoyuyc95@gmail.com\u003c/a\u003e.\n\n## License\n\nMIT - [imcuttle](https://github.com/imcuttle) 🐟\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fdetect-one-changed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimcuttle%2Fdetect-one-changed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Fdetect-one-changed/lists"}