1"use strict";(self.webpackChunk=self.webpackChunk||[]).push([["23019"],{84750(e,n,t){t.r(n),t.d(n,{metadata:()=>s,default:()=>p,frontMatter:()=>d,contentTitle:()=>r,toc:()=>i,assets:()=>a});var s=JSON.parse('{"id":"cli/docs","title":"pnpm docs","description":"Added in: v11.0.0","source":"@site/versioned_docs/version-12.x/cli/docs.md","sourceDirName":"cli","slug":"/cli/docs","permalink":"/cli/docs","draft":false,"unlisted":false,"editUrl":"https://github.com/pnpm/pnpm.io/edit/main/docs/cli/docs.md","tags":[],"version":"12.x","lastUpdatedBy":null,"lastUpdatedAt":null,"frontMatter":{"id":"docs","title":"pnpm docs"},"sidebar":"docs","previous":{"title":"pnpm search","permalink":"/cli/search"},"next":{"title":"pnpm bugs","permalink":"/cli/bugs"}}'),c=t(91987),o=t(67008);let d={id:"docs",title:"pnpm docs"},r,a={},i=[{value:"Examples",id:"examples",level:2}];function l(e){let n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.p,{children:"Added in: v11.0.0"}),"\n",(0,c.jsxs)(n.p,{children:["Aliases: ",(0,c.jsx)(n.code,{children:"home"})]}),"\n",(0,c.jsx)(n.p,{children:"Open a package's documentation (or homepage) in the browser."}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-sh",children:"pnpm docs [<pkg> ...]\n"})}),"\n",(0,c.jsx)(n.p,{children:"When run without arguments inside a package directory, it opens the documentation for the current project."}),"\n",(0,c.jsxs)(n.p,{children:["If the package does not declare a valid ",(0,c.jsx)(n.code,{children:"homepage"}),", pnpm falls back to ",(0,c.jsx)(n.code,{children:"https://npmx.dev/package/<name>"}),"."]}),"\n",(0,c.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,c.jsx)(n.p,{children:"Open the documentation for a published package:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-sh",children:"pnpm docs lodash\n"})}),"\n",(0,c.jsx)(n.p,{children:"Open the documentation for multiple packages at once:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-sh",children:"pnpm docs react react-dom\n"})}),"\n",(0,c.jsx)(n.p,{children:"Open the documentation for the current project:"}),"\n",(0,c.jsx)(n.pre,{children:(0,c.jsx)(n.code,{className:"language-sh",children:"pnpm docs\n"})})]})}function p(e={}){let{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},67008(e,n,t){t.d(n,{R:()=>d,x:()=>r});var s=t(71763);let c={},o=s.createContext(c);function d(e){let n=s.useContext(o);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.