Skip to content

Commit 02ad0f0

Browse files
committed
docs: update README with SSG emphasis
Adjusted the README documentation to highlight the static site generation (SSG) capability of the Next.js & Lingui starter project. The changes reached from the project's overview to its key features. This puts more focus on the SSG advantages and the improved translation management for multilingual sites it offers, thus providing a more accurate project description. These modifications are aimed at better addressing the interests of our user base who largely engage in SSG.
1 parent 9d5d5b3 commit 02ad0f0

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,31 @@
66
[![Twitter Follow](https://img.shields.io/badge/follow-%40nekofar-1DA1F2?logo=twitter&style=flat)](https://twitter.com/nekofar)
77
[![Donate](https://img.shields.io/badge/donate-nekofar.crypto-a2b9bc?logo=ko-fi&logoColor=white)](https://ud.me/nekofar.crypto)
88

9-
109
### Overview
1110

12-
Welcome to the Next.js & Lingui starter project! This repository demonstrates the seamless integration of Next.js, a
13-
powerful React framework for building server-side rendered applications, with Lingui, the ultimate solution for
14-
multi-lingual support in web projects.
11+
Welcome to the Next.js and Lingui static site generation (SSG) starter project! This repository demonstrates the
12+
state-of-the-art integration of Next.js and Lingui for creating static web apps with multi-lingual support.
13+
14+
Next.js, a powerful React framework, is designed to build server-rendered React applications and SSG sites. In this
15+
context, we're utilizing Next.js's Static Site Generation capabilities to pre-render pages at build time.
1516

16-
Our goal is to showcase the process of creating a multi-lingual website that caters to a diverse global audience. With
17-
Next.js providing performance and SEO advantages, and Lingui simplifying translation management, this demo project
18-
highlights the best practices for internationalization and localization.
17+
Combined with Lingui, an i18n (internationalization) library for JavaScript, we've endeavored to produce a multilingual
18+
static website that effectively caters to a global audience.
19+
20+
Our aim with this starter project is to illustrate the procedure of building an international static web app that is
21+
performant, SEO-advantaged, and maintains simplified translation management, courtesy of the capabilities brought about
22+
by the coupling of Next.js's SSG and Lingui.
1923

2024
### Key Features
2125

22-
* **Next.js Benefits**: Experience the advantages of using Next.js for server-side rendering, static site generation, and
23-
client-side routing. Learn how it enhances performance, SEO, and simplifies development.
24-
* **Lingui's Power**: Explore Lingui's capabilities in handling translations, message extraction, language pluralization,
25-
and locale-specific formatting.
26-
* **Dynamic Language Switching**: Witness real-time language switching, enabling users to seamlessly toggle between
27-
different languages without losing their place on the site.
26+
* **Static Site Generation with Next.js**: Experience the unique advantages of utilizing Next.js in our static web
27+
application. This includes benefits such as improved performance and SEO, client-side routing, and a more streamlined
28+
development process.
29+
* **Translation Management with Lingui**: Discover how Lingui simplifies handling translations in our static web app,
30+
from message extraction to language pluralization and localized formatting.
31+
* **Real-time Language Switching**: Experience an interactive feature of our static web app that enables dynamic
32+
language switching. This allows users to effortlessly switch between different languages without navigating away from
33+
their current page.
2834

2935
### Getting Started
3036

@@ -37,7 +43,7 @@ Then, to use this project template, follow these steps:
3743
3. Install project dependencies: `pnpm install`
3844
4. Start the development server: `pnpm run dev`
3945
5. Open your browser and visit http://localhost:3000 to see the application in action.
40-
46+
4147
### Contributing
4248

4349
We welcome contributions to this project! To contribute, follow these steps:

0 commit comments

Comments
 (0)