10cl / markdown-it-quote

use it to your articles with new standard definitions, give your code a home

markdown-it-quote

English | 简体中文

---

markdown-it-quote is a plugin for markdown-it that enhances code fences with various functionalities.

Do you love the style shown above? You can effortlessly achieve it with MarkdownQuote. MarkdownQuote is a JetBrains plugin designed to help you efficiently copy code fences in your IDE. For more details, visit the SourceCodeTrace Project.

Usage

To use markdown-it-quote, install the package via NPM:

npm i markdown-it-quote

Then, you can use it in your JavaScript code like this:

const MarkdownIt = require('markdown-it');
const markdownQuote = require('markdown-it-quote');

const md = new MarkdownIt();
md.use(markdownQuote);

md.render(markdownString);

Note that the highlighted line between the language name and opening curly bracket is optional.

For added customization, you can apply some custom styles to the gist meta, as recommended:

.gist-meta-quote {
  font-size: 12px;
  padding: 10px;
  overflow: hidden;
  color: white;
  border-radius: 0 0 6px 6px;
}

.gist-meta-quote a {
  float: right;
  color: white;
  text-decoration: underline;
}

See Vuepress Example for an illustrative implementation.

Feel free to tweak the styles to match your preferences.

More Examples

Here are some usage examples to demonstrate various functionalities:

• Wrap lines 3125 to 3131, and highlight lines 3126 to 3130, linking to a URL:

  ```java {3125-3131} {3129,3131} (https://github.com/10cl/fwkdev/blob/android-13.0.0_r52/dev/src/frameworks/base/services/core/java/com/android/server/am/OomAdjuster.java#L3125-L3131)
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

• Wrap lines 3125 to 3131, linking to a URL:

  ```java {3125-3131} (https://github.com/10cl/fwkdev/blob/android-13.0.0_r52/dev/src/frameworks/base/services/core/java/com/android/server/am/OomAdjuster.java#L3125-L3131)
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

• Just link to a URL:

  ```java (https://github.com/10cl/fwkdev/blob/android-13.0.0_r52/dev/src/frameworks/base/services/core/java/com/android/server/am/OomAdjuster.java#L3125-L3131)
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

• Highlight lines 1 to 2:

  ```java {1-2}
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

• Highlight line 3:

  ```java{3}
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

• Just specify the language:

  ```java
          // Use current adjustment when freezing, set adjustment when unfreezing.
          if (state.getCurAdj() >= ProcessList.CACHED_APP_MIN_ADJ && !opt.isFrozen()
                  && !opt.shouldNotFreeze()) {
              mCachedAppOptimizer.freezeAppAsyncLSP(app);
          } else if (state.getSetAdj() < ProcessList.CACHED_APP_MIN_ADJ) {
              mCachedAppOptimizer.unfreezeAppLSP(app, oomAdjReason);
          }
      }

Contributing

If you would like to contribute to this project, follow these steps:

1. Fork the repository.
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 😄

Author

markdown-it-quote is authored and maintained by 10cl and released under the MIT License. Special thanks to all the contributors (list) who have helped improve this