Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shreyasminocha/regex-for-regular-folk

🔍💪 Regular Expressions for Regular Folk — A visual, example-based introduction to RegEx [BETA]
https://github.com/shreyasminocha/regex-for-regular-folk

book ebook examples hacktoberfest refrf regex regexp regular-expression regular-expressions tutorial

Last synced: 26 days ago
JSON representation

🔍💪 Regular Expressions for Regular Folk — A visual, example-based introduction to RegEx [BETA]

Awesome Lists containing this project

README

        

# [Regular Expressions for Regular Folk](https://refrf.dev)

[![Node CI](https://github.com/shreyasminocha/regex-for-regular-folk/workflows/Node%20CI/badge.svg)](https://github.com/shreyasminocha/regex-for-regular-folk/actions)
[![Latest Version](https://img.shields.io/github/v/release/shreyasminocha/regex-for-regular-folk)](https://github.com/shreyasminocha/regex-for-regular-folk/releases/latest)

This is an experimental “book” about regular expressions. It is largely _visual_ and _example-based_, as opposed to most regex resources I found while I was learning. I also attempted to choose test cases that highlight some common gotchas. I think it’ll be worth your time.

[![Screenshot from /chapters/escapes](https://raw.githubusercontent.com/shreyasminocha/regex-for-regular-folk/master/static/images/screenshot.jpg)](https://refrf.dev)

This book’s intended audience is _regex beginners_. Some programming experience is assumed. It does not go into advanced regex concepts like engine backtracking and recursive regexes—at least not at the moment.

This is also an open source project, and contributions are welcome.

[Read it online](https://refrf.dev).

## Translations

Translations are welcome, as long as they adhere to the [license](#license).

- Chinese
- External [translation](https://elsaooo.github.io/regex/regex-you-should-know.html) by [@ElsaOOo](https://github.com/ElsaOOo)
- External [translation](https://blog.csdn.net/weixin_43466871/article/details/106001050) by [@singagain](https://github.com/singagain)
- [_Your language?_](contribution.md)

You can choose to publish your translation separately, but we welcome [translations on here](contribution.md) too!

## Printing

A [single-page version of the book](https://refrf.dev/book) is available. Print it ordinarily. Make sure to enable “Print Background Colors” on Firefox and “Background graphics” (under “More settings”) on Chrome.

## Releases

Check the [releases tab](https://github.com/shreyasminocha/regex-for-regular-folk/releases) for a list of releases. A PDF version of each release—`book.pdf`—is present under “Assets”.

## Built With

- [MDX](https://mdxjs.com) ✨
- [GatsbyJS](https://gatsbyjs.org) 🎩
- [Vercel](https://vercel.com) 🚀

## Acknowledgements

Thanks to all [contributors](https://github.com/shreyasminocha/regex-for-regular-folk/graphs/contributors) for creating issues, sharing feedback, and creating pull requests!

I referred to [RegExr](https://regexr.com) and its community patterns—great resources. I also borrowed some examples from the [iHateRegex](https://ihateregex.io) collection.

## Contributing

Thanks for taking the initiative to contribute to REFRF! 🎉

Please check our [Contribution Guide](contribution.md) for more information.

## License

Chapter content (`chapters/*`) is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0).

The source code for the website is licensed under the [MIT License](https://shreyas.mit-license.org/2019)

---

![Cover](https://raw.githubusercontent.com/shreyasminocha/regex-for-regular-folk/master/static/images/cover/cover.svg)