Light

prosegrinder / annotatedtext-remark Goto Github PK

A lightweight JavaScript library based on annotatedtext and remark-parse for converting markdown documents into an annotated text format consumable by LanguageTool as AnnotatedText.

Home Page: https://www.prosegrinder.com/annotatedtext-remark/

License: MIT License

JavaScript 73.53% TypeScript 26.47%

annotatedtext languagetool parsers markdown

annotatedtext-remark's Introduction

annotatedtext-remark

A lightweight JavaScript library based on annotatedtext, remark-parse, and remark-frontmatter for converting markdown documents into an annotated text format consumable by LanguageTool as AnnotatedText.

Front matter is now tagged as markup.

Documentation

For details, please see https://www.prosegrinder.com/annotatedtext-remark.

Install

This package is ESM only. Node 12+ is needed to use it, and it must be imported instead of required.

npm:

npm install annotatedtext-remark

Usage

Use build to convert valid Markdown into AnnotatedText.

import { build } from "annotatedtext-remark";

const text = "# Hello World\n\nThis is a paragraph.";
const annotatedtext = build(text);
const ltdata = JSON.stringify(annotatedtext);

annotatedtext-remark's People

Contributors

Stargazers

Watchers

annotatedtext-remark's Issues

Options for Disabling Specific Tokenizers

Leverage remark-disable-tokenizers to disable specific tokenizers using options. Fixing davidlday/vscode-languagetool-linter#132 may require disabling escape characters, which I don't want to code directly into the library.

Escape Character

remarkjs/remark#306 causes the escape character \ to disappear in the resulting AST. Offsets are correct, but both markup and interpretAs are set to an empty string (""). markup values should be validated against the original string.

Ignore Frontmatter

Add option to use remark-frontmatter.

Treat Code as Text

See "Words in backticks seem to be invisible to the linter". Words inside inline code back ticks are treated as markeup. Instead, at least the words should appear as text.

Recommend Projects

React

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

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

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.