4a97643664
examples: fix readmes ( #78483 )
2025-04-23 20:48:58 -05:00
36dce2fe7e
examples: add StackBlitz preview to README.md ( #73546 )
...
### Description
Follow up #35349 .
1. Update the [example
template](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md )
with [StackBlitz](https://stackblitz.com/ ) preview
2. Add `preview live with StackBlitz` to the examples
3. Remove the below old StackBlitz preview section from the examples
```md
## Preview
Preview the example live on [StackBlitz](http://stackblitz.com/ ):
[](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/active-class-name )
```
CC: @samcx
### Improving Documentation
- [x] Run `pnpm prettier-fix` to fix formatting issues before opening
the PR.
- [x] Read the Docs Contribution Guide to ensure your contribution
follows the docs guidelines:
https://nextjs.org/docs/community/contribution-guide
### Adding or Updating Examples
- [x] The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- [x] Make sure the linting passes by running `pnpm build && pnpm lint`.
See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md
2025-01-14 05:24:51 +00:00
9d371bfa82
examples: unify related CMS examples in README ( #73247 )
...
## What?
Add missing related CMS examples and sort them.
## Why are
[cms-keystonejs-embedded](https://github.com/vercel/next.js/tree/canary/examples/cms-keystonejs-embedded )
and
[cms-strapi](https://github.com/vercel/next.js/tree/canary/examples/cms-strapi )
lacking?
Because these have only README.md file.
## How?
Update with the following text.
```md
- [AgilityCMS](/examples/cms-agilitycms)
- [Builder.io](/examples/cms-builder-io)
- [ButterCMS](/examples/cms-buttercms)
- [Contentful](/examples/cms-contentful)
- [Cosmic](/examples/cms-cosmic)
- [DatoCMS](/examples/cms-datocms)
- [DotCMS](/examples/cms-dotcms)
- [Drupal](/examples/cms-drupal)
- [Enterspeed](/examples/cms-enterspeed)
- [Ghost](/examples/cms-ghost)
- [GraphCMS](/examples/cms-graphcms)
- [Kontent.ai](/examples/cms-kontent-ai)
- [MakeSwift](/examples/cms-makeswift)
- [Payload](/examples/cms-payload)
- [Plasmic](/examples/cms-plasmic)
- [Prepr](/examples/cms-prepr)
- [Prismic](/examples/cms-prismic)
- [Sanity](/examples/cms-sanity)
- [Sitecore XM Cloud](/examples/cms-sitecore-xmcloud)
- [Sitefinity](/examples/cms-sitefinity)
- [Storyblok](/examples/cms-storyblok)
- [TakeShape](/examples/cms-takeshape)
- [Tina](/examples/cms-tina)
- [Umbraco](/examples/cms-umbraco)
- [Umbraco heartcore](/examples/cms-umbraco-heartcore)
- [Webiny](/examples/cms-webiny)
- [WordPress](/examples/cms-wordpress)
- [Blog Starter](/examples/blog-starter)
```
CC: @samcx
### Adding or Updating Examples
- [x] The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- [x] Make sure the linting passes by running `pnpm build && pnpm lint`.
See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md
Co-authored-by: Sam Ko <sam@vercel.com >
2024-12-10 06:22:34 +00:00
fa88095f44
examples: Update Example Prepr CMS ( #49224 )
...
Co-authored-by: Kevintjuhz <kevin@kqcreations.com >
Co-authored-by: Kevintjuhz <k.quaedvlieg@outlook.com >
Co-authored-by: Lee Robinson <me@leerob.io >
2023-08-14 07:13:50 -05:00
15cc88909c
chore(examples): Add dotCMS example ( #38214 )
...
<!--
Thanks for opening a PR! Your contribution is much appreciated.
In order to make sure your PR is handled as smoothly as possible we
request that you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->
This adds a new example under cms-dotcms/. Is a general-purpose example
that should allow developers to undestand how to use next.js with dotCMS
apis.
## Bug
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
## Feature
- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [x] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`
## Documentation / Examples
- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples )
Co-authored-by: Daniel Esteves <estevesd8@gmail.com >
Co-authored-by: Will Ezell <will@dotcms.com >
Co-authored-by: Arcadio Quintero A <oidacra@gmail.com >
Co-authored-by: Rafael <rjvelazco21@gmail.com >
2022-10-01 15:26:13 +02:00
88ac118d1c
Add Enterspeed blog example ( #35897 )
...
# Demo: https://next-blog-demo.enterspeed.com/
Added `with-enterspeed` to examples.
Linked to `with-enterspeed` in related documentation:
- docs/advanced-features/preview-mode.md
- docs/basic-features/data-fetching/overview.md
- docs/basic-features/pages.md
Linked to `with-enterspeed` in related examples:
- examples/blog-starter/README.md
- examples/cms-agilitycms/README.md
- examples/cms-builder-io/README.md
- examples/cms-buttercms/README.md
- examples/cms-contentful/README.md
- examples/cms-cosmic/README.md
- examples/cms-datocms/README.md
- examples/cms-drupal/README.md
- examples/cms-ghost/README.md
- examples/cms-graphcms/README.md
- examples/cms-kontent/README.md
- examples/cms-prepr/README.md
- examples/cms-prismic/README.md
- examples/cms-sanity/README.md
- examples/cms-storyblok/README.md
- examples/cms-strapi/README.md
- examples/cms-takeshape/README.md
- examples/cms-tina/README.md
- examples/cms-umbraco-heartcore/README.md
2022-09-30 01:48:00 +02:00
c3e5caf110
docs(examples): improve DX while copying command to create new project ( #38410 )
...
* docs(examples): improve DX while copy command to create new project
* chore: apply code review
Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com >
Co-authored-by: JJ Kasper <jj@jjsweb.site >
2022-07-26 21:57:48 -05:00
57dcc9d329
Update pnpm create next-app for latest pnpm 6 and 7 ( #37254 )
...
This command changed in pnpm [6.32.13](https://github.com/pnpm/pnpm/releases/tag/v6.32.13 ) and [7.1.1](https://github.com/pnpm/pnpm/releases/tag/v7.1.1 ) so lets update it since its been a few weeks and we can expect pnpm users to update more regularly than npm users.
- Fixes https://github.com/vercel/next.js/pull/37240
- Fixes https://github.com/vercel/next.js/pull/37045
- Fixes https://github.com/vercel/next.js/pull/37032
- Fixes https://github.com/vercel/next.js/pull/36602
- Fixes https://github.com/vercel/next.js/pull/36496
2022-05-27 21:21:40 +00:00
3e178bb801
add pnpm link to docs ( #37221 )
...
## Documentation / Examples
- [x] Make sure the linting passes by running `yarn lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples )
Co-authored-by: Steven <steven@ceriously.com >
2022-05-27 15:46:38 -04:00
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
de54ad895c
[examples] Add a statically generated blog example using Next.js and Builder.io ( #22094 )
...
A statically generated blog example using Next.js and [Builder.io](https://builder.io ), demo on [https://cms-builder-io.vercel.app/ ](https://cms-builder-blog.vercel.app/ )
2022-01-12 21:58:43 +00:00
ecf9f8775c
Add Umbraco Heartcore blog example ( #21409 )
...
Co-authored-by: Lee Robinson <me@leerob.io >
Co-authored-by: Tim Neutkens <tim@timneutkens.nl >
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-12-07 16:38:55 +01:00
32b96551e7
typo fix ( #25159 )
...
Just a simple typo fix!
2021-05-15 20:42:52 +00:00
e69a4d7a23
[examples] Added blog-starter example using Ghost CMS ( #19990 )
2021-02-07 12:27:47 -06:00
Lee Robinson
