https://github.com/sebastiandotdev/md-link

Md-links comprueba tus links .
https://github.com/sebastiandotdev/md-link

Last synced: 25 days ago
JSON representation

Md-links comprueba tus links .

• Host: GitHub
• URL: https://github.com/sebastiandotdev/md-link
• Owner: sebastiandotdev
• Created: 2023-02-12T19:48:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-03-01T18:21:43.000Z (over 1 year ago)
• Last Synced: 2024-08-26T18:53:56.548Z (2 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/ss-validate-md
• Size: 108 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## MD Link

## indice

- Preambulo

- Instalacion

- Uso

- Author

## Preambulo

- mdLinks es una herramienta de node js que nos ayuda a validar archivos `markdown`, permitiendonos saber:

1. cantidad de links

2. links roto

3. links unicos.

## Instalacion

- para instalar esta herramienta te sugerimos continuar los siguientes pasos:

1. instalar mdLinks de forma global

```

npm install -g  mdLinks

```

2. También puedes instalar mdLinks como una dependencia de desarrollo:

```

npm install mdLinks --save-dev

```

## Uso

- una vez instalada la herramienta a su proyecto , continua los siguientes pasos:

1. si lo instaló de forma global solo es llamar la herramienta y pasarle el archivo `markdown`

```

mdLinks 

```

2. si lo instaló como una dependecia de desarrollo utilice el siguiente comando:

```

npx mdLinks 

```

- obtendra informacion de todos los links encontrados en su archivo `.md`

```js

[

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link"

  },

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link"

  },

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link"

  }

]

```

### Opcion validate

- puedes usar la opcion `--validate` para comprobar el estado de su link, para usarlo siga los siguientes pasos:

```

mdLinks  --validate

```

```

npx mdLinks  --validate

```

- tendra el siguiente resultado:

```js

[

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link",

    status: 200,

    OK: "OK"

  },

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link",

    status: 200,

    OK: "OK"

  },

  {

    file: "name of your file",

    link: "name of the link",

    text: "content of the link",

    status: 200,

    OK: "OK"

  }

]

```

### Opcion stats

- puedes usar la opcion `--stats` si deseas ver las estadisticas de tus links,ejecuta el siguiente comando :

```

mdLinks  --stats

```

```

npx mdLinks  --stats

```

- obtendras el siguiente resultado:

```js

[

  {

    totalFiles: 00,

    totalUnique: 00

  },

    {

    totalFiles: 00,

    totalUnique: 00

  },

    {

    totalFiles: 00,

    totalUnique: 00

  }

]

```

- obtendras una pequeña estadisticas de la cantidad de link que hay y sobre ttodo los links que no se repiten en tu archivo `md`

### validate & stats

- si usas la opcion `--validate` y la opcion `--stats` obtendras una seccion especial , y es poder ver los links que no se encuentran en funcionamiento

- ejecuta el siguiente comando:

```

mdLinks  --validate --stats

```

```

npx mdLinks  --validate --stats

```

- obtendras el siguiente resultado:

```js

[

  {

    totalFiles: 00,

    totalUnique: 00,

    broken: 0,

  },

    {

    totalFiles: 00,

    totalUnique: 00,

    broken: 0,

  },

    {

    totalFiles: 00,

    totalUnique: 00,

    broken: 0

  }

]

```

## Author

- @Sebastian009w

- johancs.mm@gmailcom