Skip to content

Commit

Permalink
Improve metadata docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
TooTallNate committed Jun 30, 2024
1 parent 0b84131 commit c87b43b
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions docs/content/runtime/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Metadata
description: Customizing the title, version, author & icon of your nx.js application
---

import { File, Folder, Files } from 'fumadocs-ui/components/files';

For distribution, you will likely want to customize the metadata for your application, as well as use a custom icon:
* Metadata information can be specified by adding specific fields to the `package.json` file
* The icon can be specified by adding a `logo.jpg` file to the root of your project
Expand All @@ -15,22 +17,22 @@ primarily relevant when utilizing the [Save Data API](/docs/switch/save-data) vi
To set the title ID of your application, add a `titleId` field to your `package.json` file.
It should contain a 16-character hexadecimal string which starts with `01` and ends with `0000`:

```json
```json title="package.json"
{
"titleId": "0123456789ab0000",
… rest of your `package.json` file …
}
```

> The `create-nxjs-app` tool automatically generatess a random title ID for you,
> The `create-nxjs-app` tool automatically generates a random title ID for you,
> so normally you will not need to create this field manually.
## Name

To set the title of your application (as shown in the homebrew menu), add either a
`productName` or `name` field to your `package.json` file:

```json
```json title="package.json"
{
"productName": "My Application",
"name": "my-application",
Expand All @@ -46,7 +48,7 @@ To set the title of your application (as shown in the homebrew menu), add either

To set the version of your application, add a `version` field to your `package.json` file:

```json
```json title="package.json"
{
"version": "0.0.1",
… rest of your `package.json` file …
Expand All @@ -57,7 +59,7 @@ To set the version of your application, add a `version` field to your `package.j

To set the author of your application, add an `author` field to your `package.json` file:

```json
```json title="package.json"
{
"author": "Nathan Rajlich <[email protected]>",
… rest of your `package.json` file …
Expand All @@ -68,12 +70,13 @@ To set the author of your application, add an `author` field to your `package.js

To set the icon of your application, add a `logo.jpg` file to the root of your project:

```bash
├── logo.jpg
├── package.json
└── src
└── main.ts
```
<Files>
<File name="logo.jpg" />
<File name="package.json" />
<Folder name="src" defaultOpen>
<File name="main.ts" />
</Folder>
</Files>

> The icon should be a square image. It will be resized to 256x256 pixels. If this file is
> not present, then the default nx.js icon will be used.

0 comments on commit c87b43b

Please sign in to comment.