GithubHelp home page GithubHelp logo

kotobuki / pandoc-sidenote-js Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 4 KB

A tool to convert Pandoc Markdown-style footnotes into side notes or margin notes

License: MIT License

JavaScript 100.00%
pandoc pandoc-filter sidenotes

pandoc-sidenote-js's Introduction

pandoc-sidenote.js

pandoc-sidenote.js is a simple Pandoc filter that converts footnotes to side notes or margin notes in Markdown documents. It is inspired by pandoc-sidenote by Jacob Zimmerman et al. and implemented in JavaScript.This filter automatically converts URLs to links as an enhancement over the original version.

Usage

To use the filter, simply run:

pandoc --filter pandoc-sidenote.js

For the side note syntax information, please refer to the documentation written for pandoc-markdown-css-theme. To test the filter, I recommend using the tool (modifying the build.sh script in the tools folder is necessary).

Acknowledgments

I would like to express my gratitude to the developers of the original pandoc-sidenote developers and the Pandoc team for their great work on creating and maintaining these projects.


pandoc-sidenote.jsは、Markdown文書内の脚注を傍注(side note:番号あり・margin note:番号なし)に変換するシンプルなPandocフィルターです。Jacob Zimmermanらによるpandoc-sidenoteから着想を得てJavaScriptで実装されています。オリジナル版からの機能拡張として、URLを自動的にリンクに変換します。

使い方

フィルターを使用するには、次のコマンドを実行します:

pandoc --filter pandoc-sidenote.js

傍注の記法については、pandoc-markdown-css-themeドキュメントを参照してください。フィルターの動作を確認するには、このテンプレートを使用することをおすすめします(toolsフォルダにあるbuild.shの書き換えが必要です)。

謝辞

オリジナル版のpandoc-sidenote開発者およびPandocチームに対して、素晴らしいツールの作成および維持に関する尽力に、心から感謝と尊敬の意を表します。

pandoc-sidenote-js's People

Contributors

kotobuki avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.