|
1 | 1 | <p align="center">
|
2 |
| - <a href="https://materializeweb.com"> |
| 2 | + <a href="https://materializeweb.com" target="_blank"> |
3 | 3 | <img src="https://materializeweb.com/images/materialize.svg" width="200">
|
4 | 4 | </a>
|
5 | 5 | </p>
|
|
9 | 9 | <p align="center">
|
10 | 10 | Materialize, a CSS Framework based on Material Design.
|
11 | 11 | <br>
|
12 |
| - <a href="https://materializeweb.com"><strong>-- Browse the docs --</strong></a> |
| 12 | + <a target="_blank" href="https://materializeweb.com"><strong>[ Browse the docs ]</strong></a> |
13 | 13 | <br>
|
14 | 14 | <br>
|
15 | 15 | <a href="https://github.com/materializecss/materialize/actions/">
|
@@ -37,26 +37,24 @@ Read the [getting started guide](https://materializeweb.com/getting-started.html
|
37 | 37 | - Include the files via [jsDelivr](https://www.jsdelivr.com/package/npm/@materializecss/materialize).
|
38 | 38 | - Install with [npm](https://www.npmjs.com): `npm install @materializecss/materialize` (Beta: `npm install @materializecss/materialize@next`)
|
39 | 39 |
|
40 |
| -## Documentation |
41 |
| -The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. |
| 40 | +## Development |
| 41 | +The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org) installed on your computer. |
42 | 42 |
|
43 |
| -### Running documentation locally |
44 |
| -Run these commands to set up the documentation: |
45 |
| - |
46 |
| -```bash |
47 |
| -git clone https://github.com/materializecss/materialize |
48 |
| -cd materialize |
| 43 | +This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation. |
| 44 | +Otherwise, if you want to develop the components itself, the dev process of this core-repo works like this: |
| 45 | +```sh |
49 | 46 | npm install
|
| 47 | +npm run dev |
50 | 48 | ```
|
51 | 49 |
|
52 |
| -Then run `npm run dev` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000/docs`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation. |
| 50 | +### Running documentation locally |
| 51 | +See [Materialize Docs Repo](https://github.com/materializecss/materialize-docs) to see Materialize in Action. |
53 | 52 |
|
54 | 53 | ### Documentation for previous releases
|
55 |
| -Previous releases and their documentation are available for [download](https://github.com/materializecss/materialize/releases). |
56 |
| - |
57 |
| -## Build |
58 |
| -If you want to build `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`. |
| 54 | +Previous releases are available [here](https://github.com/materializecss/materialize/releases). |
59 | 55 |
|
| 56 | +## Release |
| 57 | +If you want to release `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`. |
60 | 58 | ```sh
|
61 | 59 | npm run release -- --oldver=<current_version> --newver=<new_version>
|
62 | 60 | ```
|
@@ -100,4 +98,4 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
|
100 | 98 | [](https://opencollective.com/materialize#backers)
|
101 | 99 |
|
102 | 100 | ## Copyright and license
|
103 |
| -Code Copyright 2023 Materialize. Code released under the MIT license. |
| 101 | +Code Copyright 2024 Materialize. Code released under the MIT license. |
0 commit comments