Skip to content

Commit

Permalink
fix(README): Fix broken links on table of contents (#57)
Browse files Browse the repository at this point in the history
* fix(README): Fix broken links on table of contents

* misc: rephrase titles to fix broken links
  • Loading branch information
matheus1lva authored and Kent C. Dodds committed Jun 26, 2018
1 parent 92ed428 commit d8be253
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,15 @@
"contributions": [
"code"
]
},
{
"login": "PlayMa256",
"name": "Matheus Gonçalves da Silva",
"avatar_url": "https://avatars0.githubusercontent.com/u/831308?v=4",
"profile": "https://github.com/PlayMa256",
"contributions": [
"doc"
]
}
],
"repoType": "github"
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Pre-evaluate code at build-time
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]

[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
[![Babel Macro][macros-badge]][babel-plugin-macros]
Expand Down Expand Up @@ -97,8 +97,8 @@ See more below.
- [Limitations](#limitations)
- [Code transpilation](#code-transpilation)
- [FAQ](#faq)
- [How is this different from [prepack][prepack]?](#how-is-this-different-from-prepackprepack)
- [How is this different from [webpack][webpack] [loaders][webpack-loaders]?](#how-is-this-different-from-webpackwebpack-loaderswebpack-loaders)
- [How is this different from prepack?](#how-is-this-different-from-prepack)
- [How is this different from webpack loaders?](#how-is-this-different-from-webpack-loaders)
- [Inspiration](#inspiration)
- [Related Projects](#related-projects)
- [Other Solutions](#other-solutions)
Expand Down Expand Up @@ -405,28 +405,30 @@ transpilation.

## FAQ

### How is this different from [prepack][prepack]?
### How is this different from prepack?

`prepack` is intended to be run on your final bundle after you've run your
[`prepack`][prepack] is intended to be run on your final bundle after you've run your
webpack/etc magic on it. It does a TON of stuff, but the idea is that your code
should work with or without prepack.

`babel-plugin-preval` is intended to let you write code that would _not_ work
otherwise. Doing things like reading something from the file system are not
possible in the browser (or with prepack), but `preval` enables you to do this.

### How is this different from [webpack][webpack] [loaders][webpack-loaders]?
### How is this different from webpack loaders?

This plugin was inspired by webpack's [val-loader][val-loader]. The benefit of
using this over that loader (or any other loader) is that it integrates with
your existing babel pipeline. This is especially useful for the server where
you're probably not bundling your code with `webpack`, but you may be using
you're probably not bundling your code with [`webpack`][webpack], but you may be using
babel. (If you're not using either, configuring babel for this would be easier
than configuring webpack for `val-loader`).

In addition, you can implement pretty much any webpack loader using
`babel-plugin-preval`.

If you want to learn more, check `webpack` documentations about [`loaders`][webpack-loaders].

## Inspiration

I needed something like this for the
Expand Down Expand Up @@ -454,7 +456,7 @@ Thanks goes to these people ([emoji key][emojis]):
<!-- prettier-ignore -->
| [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub><b>Kent C. Dodds</b></sub>](https://kentcdodds.com)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Code") [πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Documentation") [πŸš‡](#infra-kentcdodds "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=kentcdodds "Tests") | [<img src="https://avatars3.githubusercontent.com/u/5610087?v=3" width="100px;"/><br /><sub><b>Matt Phillips</b></sub>](http://mattphillips.io)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Code") [πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Documentation") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=mattphillips "Tests") | [<img src="https://avatars1.githubusercontent.com/u/28024000?v=3" width="100px;"/><br /><sub><b>Philip Oliver</b></sub>](https://twitter.com/philipodev)<br />[πŸ›](https://github.com/kentcdodds/babel-plugin-preval/issues?q=author%3Aphilipodev "Bug reports") | [<img src="https://avatars2.githubusercontent.com/u/2109702?v=3" width="100px;"/><br /><sub><b>Sorin Davidoi</b></sub>](https://toot.cafe/@sorin)<br />[πŸ›](https://github.com/kentcdodds/babel-plugin-preval/issues?q=author%3Asorin-davidoi "Bug reports") [πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=sorin-davidoi "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=sorin-davidoi "Tests") | [<img src="https://avatars4.githubusercontent.com/u/1127238?v=4" width="100px;"/><br /><sub><b>Luke Herrington</b></sub>](https://github.com/infiniteluke)<br />[πŸ’‘](#example-infiniteluke "Examples") | [<img src="https://avatars4.githubusercontent.com/u/22868432?v=4" width="100px;"/><br /><sub><b>Lufty Wiranda</b></sub>](http://instagram.com/luftywiranda13)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=luftywiranda13 "Code") | [<img src="https://avatars0.githubusercontent.com/u/3877773?v=4" width="100px;"/><br /><sub><b>Oscar</b></sub>](http://obartra.github.io)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=obartra "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=obartra "Tests") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [<img src="https://avatars1.githubusercontent.com/u/14310216?v=4" width="100px;"/><br /><sub><b>pro-nasa</b></sub>](https://github.com/pro-nasa)<br />[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=pro-nasa "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/9248479?v=4" width="100px;"/><br /><sub><b>Sergey Bekrin</b></sub>](http://bekrin.me)<br /> | [<img src="https://avatars0.githubusercontent.com/u/18613301?v=4" width="100px;"/><br /><sub><b>Mauro Bringolf</b></sub>](https://maurobringolf.ch)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Tests") | [<img src="https://avatars1.githubusercontent.com/u/10875678?v=4" width="100px;"/><br /><sub><b>Joe Lim</b></sub>](https://joelim.me)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=xjlim "Code") | [<img src="https://avatars3.githubusercontent.com/u/13483453?v=4" width="100px;"/><br /><sub><b>Marcin Zielinski</b></sub>](https://github.com/marzelin)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=marzelin "Code") | [<img src="https://avatars3.githubusercontent.com/u/1972567?v=4" width="100px;"/><br /><sub><b>Tommy</b></sub>](http://www.tommyleunen.com)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=tleunen "Code") |
| [<img src="https://avatars1.githubusercontent.com/u/14310216?v=4" width="100px;"/><br /><sub><b>pro-nasa</b></sub>](https://github.com/pro-nasa)<br />[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=pro-nasa "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/9248479?v=4" width="100px;"/><br /><sub><b>Sergey Bekrin</b></sub>](http://bekrin.me)<br /> | [<img src="https://avatars0.githubusercontent.com/u/18613301?v=4" width="100px;"/><br /><sub><b>Mauro Bringolf</b></sub>](https://maurobringolf.ch)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Code") [⚠️](https://github.com/kentcdodds/babel-plugin-preval/commits?author=maurobringolf "Tests") | [<img src="https://avatars1.githubusercontent.com/u/10875678?v=4" width="100px;"/><br /><sub><b>Joe Lim</b></sub>](https://joelim.me)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=xjlim "Code") | [<img src="https://avatars3.githubusercontent.com/u/13483453?v=4" width="100px;"/><br /><sub><b>Marcin Zielinski</b></sub>](https://github.com/marzelin)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=marzelin "Code") | [<img src="https://avatars3.githubusercontent.com/u/1972567?v=4" width="100px;"/><br /><sub><b>Tommy</b></sub>](http://www.tommyleunen.com)<br />[πŸ’»](https://github.com/kentcdodds/babel-plugin-preval/commits?author=tleunen "Code") | [<img src="https://avatars0.githubusercontent.com/u/831308?v=4" width="100px;"/><br /><sub><b>Matheus GonΓ§alves da Silva</b></sub>](https://github.com/PlayMa256)<br />[πŸ“–](https://github.com/kentcdodds/babel-plugin-preval/commits?author=PlayMa256 "Documentation") |

<!-- ALL-CONTRIBUTORS-LIST:END -->

Expand Down

0 comments on commit d8be253

Please sign in to comment.