Commit graph

5 commits

Author SHA1 Message Date
Steven
9f9214abe5
Updated create-next-app docs to include pnpm usage (#35755)
This PR updates the docs and examples for `create-next-app` to include pnpm usage.

The following script was used to update every example README:

```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')

for (let example of examples) {
    const filename = `./examples/${example}/README.md`
    const markdown = fs.readFileSync(filename, 'utf8')
    const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
    const output = markdown.replace(regex, (yarn, group) => {
        const pnpm = `pnpm create next-app -- --example ${group}`
        return `${yarn}\n# or\n${pnpm}`
    })
    fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +00:00
Hassan El Mghari
33aa51ab26
Change README structure in examples (#35349)
Changed the README structure in all examples to take out the Stackblitz button and include it as a link instead using a [bash script](https://gist.github.com/Nutlope/a8f3556a5a401e32a8c6278b782ebf8a/revisions).

I also added the Vercel deploy button to 15 READMEs that didn't have it.
2022-03-16 21:39:26 +00:00
Manny Becerra
36eba95227
Fixes #33153: Updating cross-references from master to main + canary (#33198)
* copy cleanup in env. variables docs

* copy cleanup in fast refresh docs

* Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main`

* Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main`

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-01-12 02:55:35 +01:00
Oscar Busk
971b17f1e9
Add ci script to check examples (#28009)
* Add ci script to check examples

* Install moreutils for `sponge` command.

It's not very pretty, but I'm not sure how to replace sponge in a good way in the shell script

* Prettier names in the workflow

* Move "check-examples" into build_test_deploy workflow

* Start breaking the jq script into multiple lines

* Add checks for cleanups in vercel/next.js#27121

* Run the `check-examples.sh` script to cleanup all remaining examples.
2021-08-14 13:34:40 -05:00
Delba de Oliveira
97174ac651
Add with-cypress example (#27900)
This PR adds a with-cypress example to match the examples in upcoming docs. 

## Documentation / Examples

- [ ] Make sure the linting passes

**Note:** This PR does not pass linting because ESLint needs to have the [eslint-plugin-cypress](https://github.com/cypress-io/eslint-plugin-cypress) installed globally to ignore the Cypress methods.
2021-08-09 20:57:17 +00:00