Giter Club home page Giter Club logo

markdownurlchecker's Introduction

Introduction

This Node JS script parses .md files within "input" directory and prints out an array of broken URLs that were found.

Prerequisites

Installation

npm install

Production mode

To log incorrect errors to the console:

npm run check

To log incorrect errors to the console and create .json files with errors in the 'output' directory.

npm run checkAndExport

General concept

The URL checker works by:

  1. Finding internal markdown links via regex (e.g. [Some title](#Title--sub-title--sub-sub-title))
  2. Then, parsing the whole .md document and recursively building a headerObject, which is then used to create an array of all possible valid internal links.
  3. Comparing the two arrays. If there's an item in the array from point 3. that is not found within point 2., then an alert is raised.

markdownurlchecker's People

Contributors

hartoos avatar lukasdzenk 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.