Skip to content

Commit aac11ba

Browse files
committed
docs: Added documentation for using a GitHub template to bootstrap a new project
1 parent 51bd110 commit aac11ba

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Create an accessible React application with the
1313
application
1414
- [Creating a new app](https://react-md.dev/guides/creating-a-new-app) - How to
1515
create a new app with react-md
16+
- [Using a GitHub template](https://github.com/mlaursen/template-rmd) - Create a
17+
new repo from a GitHub template including reasonable react-md defaults and
18+
Next.js.
1619
- [Examples with Build Tools](./examples) - View and download examples of using
1720
ReactMD with build tools such as [create-react-app], [Next.js], and [Gatsby]
1821
- [Working from v1](https://react-md.dev/guides/working-with-v1) - How to use

packages/documentation/src/guides/creating-a-new-app.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ This guide will help you create a new app with `react-md` along with
44
[create-react-app] as the project bootstrapper. The basic requirements for
55
continuing are:
66

7-
- [node] installed with at least version `10` to make things simple
7+
- [node] installed with at least version `14` to make things simple
88
- [yarn] or [npm]
99
- experience in React
1010

11-
> You can also check out the
12-
> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) to see completed
13-
> examples and other build tools such as [Next.js](https://nextjs.org/).
11+
> If you want to get started immediately, you can view the
12+
> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) which outlines
13+
> quick ways to spin up a new project with different build tools. Another
14+
> alternative is using the
15+
> [react-md GitHub template](https://github.com/mlaursen/template-rmd) to
16+
> bootstrap a new repo with Next.js and some reasonable defaults.
1417
1518
## Bootstrapping a new Project
1619

0 commit comments

Comments
 (0)