From 4526b78179d886a30459b486e3235803c0e71778 Mon Sep 17 00:00:00 2001 From: Nathan Rajlich Date: Sat, 14 Dec 2024 11:07:55 -0800 Subject: [PATCH] Add docs section --- docs/app/toggle.tsx | 7 +++++++ docs/content/ncm/index.mdx | 43 ++++++++++++++++++++++++++++++++++++++ docs/content/ncm/meta.json | 10 +++++++++ docs/package.json | 1 + pnpm-lock.yaml | 3 +++ 5 files changed, 64 insertions(+) create mode 100644 docs/content/ncm/index.mdx create mode 100644 docs/content/ncm/meta.json diff --git a/docs/app/toggle.tsx b/docs/app/toggle.tsx index 40b79a30..e656e29e 100644 --- a/docs/app/toggle.tsx +++ b/docs/app/toggle.tsx @@ -1,5 +1,6 @@ import { TbClockBolt, + TbDatabaseEdit, TbGlobe, TbBrowser, TbBraces, @@ -42,6 +43,12 @@ export function Toggle() { url: '/inspect', icon: , }, + { + title: '@nx.js/ncm', + description: 'Content manager API', + url: '/ncm', + icon: , + }, { title: '@nx.js/repl', description: 'Read-Eval-Print Loop for nx.js', diff --git a/docs/content/ncm/index.mdx b/docs/content/ncm/index.mdx new file mode 100644 index 00000000..5cfd5f4c --- /dev/null +++ b/docs/content/ncm/index.mdx @@ -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 + + + + +```bash +npm install @nx.js/ncm +``` + + + + +```bash +pnpm add @nx.js/ncm +``` + + + + +```bash +yarn add @nx.js/ncm +``` + + + + +```bash +bun add @nx.js/ncm +``` + + + + diff --git a/docs/content/ncm/meta.json b/docs/content/ncm/meta.json new file mode 100644 index 00000000..0db30f5b --- /dev/null +++ b/docs/content/ncm/meta.json @@ -0,0 +1,10 @@ +{ + "root": true, + "pages": [ + "--- Documentation ---", + "index", + "...", + "--- API Reference ---", + "...api" + ] +} diff --git a/docs/package.json b/docs/package.json index 89f969f7..ed8fd67c 100644 --- a/docs/package.json +++ b/docs/package.json @@ -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", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cc4f73f9..4bfbb327 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -464,6 +464,9 @@ importers: '@nx.js/http': specifier: workspace:* version: link:../packages/http + '@nx.js/ncm': + specifier: workspace:* + version: link:../packages/ncm '@nx.js/repl': specifier: workspace:* version: link:../packages/repl