Commit graph

194 commits

Author SHA1 Message Date
Mariano Álvarez
a7faeb0b80
chore(docs): improve visual appearance of badges in README.md (#67254)
## Description
This Pull Request improves the visual appearance of the badges in the
README.md file by removing unnecessary line breaks between the badge
images, eliminating the unwanted blue link lines that previously
appeared and resulting in a cleaner and more cohesive look.

### What
Removed unnecessary line breaks between badge images in the README.md
file to eliminate the unwanted blue link lines and improve the overall
visual presentation.

### Why
Previously, the badges were displayed with line breaks between them,
causing blue link lines to appear, which disrupted the clean look of the
badges. By removing these line breaks, the badges now appear without the
blue link lines, providing a more cohesive and visually appealing
README.

### How

- Removed the line breaks between badge images in the README.md file.

Co-authored-by: Jiwon Choi <devjiwonchoi@gmail.com>
2024-06-28 07:29:25 +00:00
日高 凌
6a80f2b25d
Docs: Replace "twitter.com" to "x.com" (#65917)
### What?
Replace `twitter.com` links in the docs with `x.com`

### Why?
Now that Twitter (twitter.com) has officially moved to the x.com domain

### How?
- Replace the link, then click on the link to make sure there are no
problems

Closes NEXT-
Fixes #65916

---------

Co-authored-by: Sam Ko <sam@vercel.com>
2024-05-18 05:49:49 +00:00
Ahmed Abdelbaset
0a796d66f3
Fix duplicate line in README (#61691)
#48717 duplicated the /learn course link in README.md
2024-02-06 20:45:14 +00:00
Sam Ko
47c74dc454
chore: update README.md (#61650)
## Description

On [second thought](https://github.com/vercel/next.js/pull/48717), the
previous heading size of (`##`) looks better.

Closes NEXT-2358
2024-02-04 18:54:54 -08:00
Ishaan
d245079177
Update README.md (#48717)
## Improving Documentation

### The following changes have been made to the official repository's
**Readme.md**:

- Shortened link text across the readme.
- Added additional descriptions for more details.
- Added bold text to highlight emphasis on important topics
- Changed heading sizes to indicate first headings (h1) for each section
instead of second headings (h2) which was previously being used
- Merged _'Who is using Next.js?'_ section with _'Getting Started'_
section for a more professional, cleaner look.

### The following changes have been made to the repository's
**Contribution docs**:

- Fixed two typos in the docs

---------

Co-authored-by: Sam Ko <sam@vercel.com>
Co-authored-by: Delba de Oliveira <32464864+delbaoliveira@users.noreply.github.com>
2024-02-04 18:47:51 -08:00
Sukka
3cf7a30df9
docs(README): next.js logo with dark mode (#40223)
This PR follows #40181, adding the dark mode support for the brand new
Next.js logo (BTW, the new logo is awesome!). The dark version of the
logo is also served from `assets.vercel.com` (I just change the original
logo URL, replace the `light` with `dark`, and surprisingly find out
that doesn't result in 404).

cc @Nutlope @steven-tey 

Ref: [Specify theme context for images in Markdown (Beta) - GitHub
Blog](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/)

Currently, the Next.js README in dark mode:

<img width="917" alt="image"
src="https://user-images.githubusercontent.com/40715044/188449078-864f6b71-7741-44f4-aee6-02a281b0a263.png">

After the PR:

<img width="914" alt="image"
src="https://user-images.githubusercontent.com/40715044/188449265-a3556565-d866-4e0e-9b97-be62fba6c6fe.png">

Preview link:
https://github.com/SukkaW/next.js/tree/readme-logo-darkmode
2022-09-13 16:39:52 +02:00
Balázs Orbán
45d68ae509
Update README.md
Closes #40336
2022-09-08 13:43:12 +02:00
Hassan El Mghari
3647d7344d
Updating the Next.js Logo (#40181)
Updating the Next.js Logo, would love a quick merge
2022-09-02 12:49:45 -03:00
Balázs Orbán
6faf84ff3b
Update README.md (#38371)
* Update README.md

* Apply suggestions from code review

Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-07 23:00:34 -05:00
Dom Sip
82e63e3d74
docs(readme.md): remove broken 404 links (#38104) 2022-06-29 13:17:58 +02:00
Ananta Bastola
5f30df2f06
docs(readme.md): add good first issue section to readme (#25085)
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2021-05-18 16:10:01 -05:00
Lee Robinson
c4508d1d13
Update README to fix broken links. (#23058)
Also put current maintainers at the top of the list.
2021-03-15 16:36:24 +00:00
Luis Alvarez D
a5fea53bc8
Update logo for dark mode (#20047)
Closes https://github.com/vercel/next.js/issues/20046
2020-12-09 23:57:07 +00:00
Tim Neutkens
b902ba120f
Update README.md 2020-10-29 11:50:54 +01:00
Evil Rabbit
8fed0c3ab5
Improve Vercel's badge (#15946) 2020-08-06 12:35:36 -04:00
Mehedi Hassan
00ebce5553
More helpful README (#14830)
* More helpful README

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.

* create-next-app readme

An updated readme with more details on options, benefits, etc.

* Apply edits from code review

Co-authored-by: Luis Alvarez D. <luis@vercel.com>

* Remove redundant intro

* Update packages/create-next-app/README.md

* Remove introduction and list in showcase

* Apply suggestions from code review

* Update packages/next/README.md

Co-authored-by: Luis Alvarez D. <luis@vercel.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2020-07-23 20:56:32 -05:00
matamatanot
62ef872989
Change authors member and links (#14367) 2020-07-05 11:36:50 +02:00
Joe Haddad
b7e17e09e5
Update references to zeit/next.js (#13463) 2020-05-27 17:51:11 -04:00
Sarup Banskota
4acad75677
Link Made by Vercel to vercel.com (#12702) 2020-05-11 02:14:54 -04:00
Shu Uesugi
cc139b8d89
More renaming ZEIT → Vercel (#12649) 2020-05-09 17:21:53 +02:00
Tim Neutkens
483bd3ddda
Rename ZEIT to Vercel (#12075)
* Find/replace

* Update more URLs

* More rename

* Fix remaining examples

* More updates

* Update create-next-app

* Update remaining text

* Update

Co-authored-by: Shu Uesugi <shu@chibicode.com>
2020-04-21 11:47:12 +02:00
liulanz
39a70d8eb1
Minor change in README.md (#11434)
* changed link for JOIN THE COMMUNITY

* Update packages/next/README.md

Co-Authored-By: Luis Alvarez D. <luis@zeit.co>

Co-authored-by: Luis Alvarez D. <luis@zeit.co>
2020-03-28 12:58:42 -05:00
Tim Neutkens
c0f42837bf
Update README.md 2020-02-26 15:00:26 +01:00
Luis Alvarez D
a15ccbc0fe Update readme to link to the new docs (#10096)
* Updated next readme

* Delete README_old.md

* Update README.md

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
2020-01-15 11:25:18 +01:00
Luis Alvarez D
18d8c90c3f Updated docs for pathname (#9964)
* Updated docs for pathname

* Apply suggestions from Tim

Co-Authored-By: Tim Neutkens <tim@timneutkens.nl>

* Removed trailing dots

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
2020-01-08 11:56:17 +01:00
Taylor Bryant
eee4efd0e8 Fix typo (change imperatively to imperative) (#9750) 2019-12-14 11:56:33 -07:00
Lachlan Campbell
590e8d5c26 Fix docs typo: “your sites SEO” (#9579) 2019-11-30 22:16:46 -05:00
Lee Robinson
b3dbcbb5bb Fix typo in API routes documentation. (#9373) 2019-11-10 20:07:45 -08:00
Luis Alvarez D
c8c4efba6c Remove the parameterized-routing example (#9297)
* Remove the example

* Include readme with link to alternative
2019-11-07 10:06:35 -08:00
Tim Neutkens
37ee8fc9e7 Update _app documentation to reflect no longer needing next/app (#9268)
* Update _app documentation to reflect no longer needing next/app

* Remove lint-staged
2019-10-31 10:53:55 -04:00
Joe Haddad
4dbd267c6a
Split TypeScript Flag Docs (#9231)
* Split TypeScript Flag Docs

* reword
2019-10-28 22:44:10 -04:00
Alexander Kachkaev
ad2a3d65fd Add configuration flags to disable integrated type checker (#9138)
* Add a configuration flag to disable integrated type checker

* Add tests for typescript-transpileonly

* Restore removed argument

* Make output more coherent

* Split transpileOnly into ignoreDevErrors and ignoreBuildErrors

* Minor stylistic change
2019-10-28 11:02:03 -07:00
Miguel Ángel Durán
8227baf42c docs(api-routes): fix micro-cors example (#9184)
The correct option to use with `micro-cors` package is `allowMethods` instead `allowedMethods`. This PR fixes the example.
2019-10-23 17:14:51 -04:00
Nishant Singh
09681cd597 [Docs] Update static file serving section (#9062)
This block seemed redundant 

```
To serve static files from the root directory you can add a folder called `public` and reference those files from the root, e.g: `/robots.txt`.
```

The block above this already mentions the same thing:
```
Create a folder called `public` in your project root directory. From your code you can then reference those files starting from the baseURL `/`
```

We could add the `robots.txt` eg to the first block itself if necessary
2019-10-13 19:18:10 +02:00
JJ Kasper
5b574fc778
Update to error on usage of serverRuntimeConfig with serverless (#9030)
* Update to error on usage of serverRuntimeConfig with serverless

* Add tests for errors for serverless and runtime configs

* Update docs wording
2019-10-10 16:56:38 -05:00
JJ Kasper
28377a783b Add static directory deprecation warning (#8636)
* Add static directory warning

* Simplify migration to public directory

* Update static-dir-deprecated.md
2019-10-06 13:57:41 +02:00
Joe Haddad
9a4234cf54
Remove Recipes from Readme (#8939)
These Recipies are not regularly audited to ensure they're using the most up-to-date and suggested practices.

We'll reintroduce the idea of "recipies" in the future, for now, the examples directory is a great place to start.
2019-10-02 18:17:21 -04:00
Joe Haddad
29c1b93c89
s/Automatic Prerendering/Automatic Static Optimization/ (#8940)
* s/Automatic Prerendering/Automatic Static Optimization/

* Update more links
2019-10-02 18:03:00 -04:00
Tim Neutkens
0bcd1fc39b
Mirror actual /_error behavior in documentation 2019-09-30 11:19:03 +02:00
JJ Kasper
a8e3b02236 Add src directory support (#8735)
* Add find-pages-dir

* Add support for src directory

* Add test for pages dir preference

* Update comment
2019-09-24 17:15:14 +02:00
David Darnes
82f7bb4b67 Ghost URL Typo (#8828) 2019-09-23 12:15:27 +02:00
David Darnes
b4946ae23c Add Working with Ghost and Next.js to Recipes (#8800) 2019-09-19 17:32:43 -04:00
Luis Alvarez D
0eda4d5988 Update broken links (#8793) 2019-09-19 10:50:50 -04:00
Lukáš Huvar
7863b60ef6 Prettier fix (#8754) 2019-09-16 15:24:42 +02:00
Azim Atefi
a0341ea150 Convert Readme Custom Error Pages To Functional Component (#8513)
* Convert Readme Custom Error Pages To Functional Component

* Update packages/next/README.md

Co-Authored-By: Tim Neutkens <tim@timneutkens.nl>

* Run readme through prettier
2019-09-16 14:30:50 +02:00
JJ Kasper
fe7c7342c7 Add link to docs for prerender indicator and allow disabling (#8610)
* Add link to docs for prerender indicator and allow disabling

* Fix lint error from example

* Disable by default when electron is detected

* Add button to dismiss indicator for session

* Update disabling indicator in electron
2019-09-15 23:18:11 +02:00
Romain
98f368f545 Add missing Link import to routing doc (#8728) 2019-09-13 14:43:14 +02:00
Lukáš Huvar
9731e7e99c [Docs] Prefetch disabled for 2g or SaveData header (#8717) 2019-09-12 13:11:34 +02:00
Joe Haddad
73b6c1e633
[docs] useRouter cannot be used with classes (#8649)
The `useRouter` function is a hook and cannot be used with Classes.

A few React beginners have brought this up, so we document the alternatives to hooks.
2019-09-05 23:05:59 -04:00
Alex Matseshe
e78324a742 Fix typo in README.md #8640 (#8642) 2019-09-05 14:43:37 -05:00