Giter Club home page Giter Club logo

lint-fm's Introduction

lint-md-fm

GitHub Action linting markdown & its frontmatter content.

Development

This repo has been created with yarn.

To be able to test the action also install act.

Further, to publish the action without node_modules coming in the way, install ncc.

To ease formatting, prettier is installed and may be called for testing with:

yarn format

and with

yarn format:fix

to automatically fix formatting.

Info

More info on creating JavaScript GitHub actions may be found on GitHub.


Currently: Hello world javascript action

This action prints "Hello World" or "Hello" + the name of a person to greet to the log.

Inputs

who-to-greet

Required The name of the person to greet. Default "World".

Outputs

time

The time we greeted you.

Example usage

uses: actions/[email protected]
with:
  who-to-greet: "Mona the Octocat"

TODO

Adapt this action to one we can use to check the ecosystem projects for:

  • project files in a PR not correctly named {project-name}.md with .md ext
  • missing or misnamed logo files
  • logo files in the wrong format (not SVG / PNG / JPG)
  • (only for bonus-points: image sizes)
  • categories not in the CATEGORY_MAPPING
  • adapt this README file to the functionality of the final action

Find gray-matter already installed to work with Markdown & Frontmatter.

lint-fm's People

Contributors

swmd avatar timhagn 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.