Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
align-right

GitHub Action

Resk Gister - create gists for your tutorial.

v1.2

Resk Gister - create gists for your tutorial.

align-right

Resk Gister - create gists for your tutorial.

Resk helps you create gists from your source code

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Resk Gister - create gists for your tutorial.

uses: maticzav/[email protected]

Learn more about this action in maticzav/resk

Choose a version

✂️ resk

Resk helps you create gists from your source code.

How to use?

It's so simple! Add a start and end comment to the part of the code you would like to turn into a gist.

For example, if you had a TypeScript file, you could do something like this:

/* resk start "users" */
const users = {
  matic: {
    id: 1,
    name: 'Matic',
    role: 'admin',
  },
}
/* resk end */

/* resk start "libraries" */
const libraries = {
  resk: {
    cool: 9001,
  },
}
/* resk end */

This would create two gists - one named users and one named libraries. Besides that, it will also create a dump in .github/resk.json which includes pointers to your latest gists. This way, you don't have to change urls as you push changes.

Embed:

  • https://resk.now.sh/api/gist?repo=label-sync&owner=maticzav&gist=tutorial.ts
  • <script src="https://resk.now.sh/api/gist?repo=label-sync&owner=maticzav&gist=tutorial.ts"></script>

Supported languages:

  • Typescript/Javascript: /* resk start "<gist>" */, /* resk end */

Note: resk automatically ignores everything in **/tests/**, **/dist/**, and **/node_modules/**.

Example usage:

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: maticzav/[email protected]

Why resk?

Scissors make a "resk" when you cut the paper. Making gists is like cutting gists out of a big paper.

Contributing

Please create a PR with the new features. To add a new language please add a language specification in index file, create a test case, and add documentation above. You might also need to update the some snapshots. Use yarn test -u to do that.

Thank you for contributing! 🙌

License

MIT @ Zavadlal Matic