Skip to content

Commit

Permalink
Add docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
TooTallNate committed Dec 14, 2024
1 parent 1420421 commit 4526b78
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/app/toggle.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
TbClockBolt,
TbDatabaseEdit,
TbGlobe,
TbBrowser,
TbBraces,
Expand Down Expand Up @@ -42,6 +43,12 @@ export function Toggle() {
url: '/inspect',
icon: <TbZoomQuestion size={24} />,
},
{
title: '@nx.js/ncm',
description: 'Content manager API',
url: '/ncm',
icon: <TbDatabaseEdit size={24} />,
},
{
title: '@nx.js/repl',
description: 'Read-Eval-Print Loop for nx.js',
Expand Down
43 changes: 43 additions & 0 deletions docs/content/ncm/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Usage
description: "Content Manager (ncm) service IPC wrapper for nx.js applications"
---

The `@nx.js/ncm` package provides a wrapper for the `ncm` service IPC, which allows
for management of the Nintendo Content Manager storage.

In short, use this package for overclocking your Switch.

## Installation

<InstallTabs items={['npm', 'pnpm', 'yarn', 'bun']}>
<Tab value='npm'>

```bash
npm install @nx.js/ncm
```

</Tab>
<Tab value="pnpm">

```bash
pnpm add @nx.js/ncm
```

</Tab>
<Tab value='yarn'>

```bash
yarn add @nx.js/ncm
```

</Tab>
<Tab value='bun'>

```bash
bun add @nx.js/ncm
```

</Tab>

</InstallTabs>
10 changes: 10 additions & 0 deletions docs/content/ncm/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"root": true,
"pages": [
"--- Documentation ---",
"index",
"...",
"--- API Reference ---",
"...api"
]
}
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"@nx.js/constants": "workspace:*",
"@nx.js/clkrst": "workspace:*",
"@nx.js/http": "workspace:*",
"@nx.js/ncm": "workspace:*",
"@nx.js/repl": "workspace:*",
"@types/mdx": "^2.0.13",
"@types/node": "20",
Expand Down
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4526b78

Please sign in to comment.