https://github.com/Krzysztof-Cieslak/CodeHike-block

GitHub Block to display Code Hike code walkthroughs
https://github.com/Krzysztof-Cieslak/CodeHike-block

github-blocks

Last synced: about 2 months ago
JSON representation

GitHub Block to display Code Hike code walkthroughs

• Host: GitHub
• URL: https://github.com/Krzysztof-Cieslak/CodeHike-block
• Owner: Krzysztof-Cieslak
• License: mit
• Created: 2022-11-16T21:28:14.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-17T16:53:29.000Z (almost 2 years ago)
• Last Synced: 2024-06-04T23:58:26.688Z (4 months ago)
• Topics: github-blocks
• Language: TypeScript
• Homepage:
• Size: 182 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CodeHike Block

[![name](https://img.shields.io/badge/GitHub%20Blocks-Build%20with%20%E2%9D%A4%EF%B8%8F%EF%B8%8F-blue?style=for-the-badge)](https://blocks.githubnext.com/)

Block for displaying code walkthroughs with [CodeHike](https://codehike.org/). It's best used together with Markdown Block - to embed the walkthroughs directly in your interactive Readme. 

Here below, is the basic example of how to use it in the readme:

And here is another, longer example: 

The implementation is based on the [CodeHike Playground](https://github.com/code-hike/codehike/tree/next/playground)

## How to contribute

_Imposter syndrome disclaimer_: I want your help. No really, I do.

There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.

I assure you, that's not the case.

This project has some clear Contribution Guidelines and expectations that you can [read here](CONTRIBUTING.md).

The contribution guidelines outline the process that you'll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.

And you don't just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work. (And yes, that includes giving feedback about the contribution guidelines.)

Thank you for contributing!

## Contributing and copyright

The project is hosted on [GitHub](https://github.com/Krzysztof-Cieslak/CodeHike-block) where you can [report issues](https://github.com/Krzysztof-Cieslak/CodeHike-block/issues), participate in [discussions](https://github.com/Krzysztof-Cieslak/CodeHike-block/discussions), fork

the project and submit pull requests.

The library is available under [MIT license](LICENSE.md), which allows modification and redistribution for both commercial and non-commercial purposes.

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.