@rapidoc/prerender 0.0.0-stage → 0.1.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Mrinmoy Majumdar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @rapidoc/prerender
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Renders RapiDoc API documentation to HTML at build time, in Node, Bun or any framework's build (Astro, Next.js, Nuxt, 11ty, VitePress):
+
+- **`renderRapiDoc({ spec, ...options })`**: a pre-rendered `<rapi-doc>`, as Declarative Shadow DOM (the element hydrates over it) or as plain light-DOM HTML. Also `renderEndpoint` and `renderSchema` for single pieces.
+- **`getNavBarHtml(spec, options)`**, **`getNavCss()`**, **`getThemeTokensCss()`**: a static sidebar to place beside a headless `<rapi-doc>`, as `@rapidoc/portal` does.
+- **`renderArazzoWorkflow(arazzo, options)`** and **`getFlowCss()`**: an Arazzo workflow as an SVG diagram.
+- **`methodPathSlug`**, **`operationAnchorSource`**, **`toKebabCase`**: the anchors `<rapi-doc>` uses, for links into it.
+
+It renders the same templates as the `rapidoc` web component, so the HTML matches what the element shows.
+
+## Use
+
+```bash
+npm install @rapidoc/prerender
+```
+
+```javascript
+import { renderRapiDoc } from "@rapidoc/prerender";
+
+const html = await renderRapiDoc({ spec: "./openapi.yaml", outputMode: "dsd" });
+```
+
+Load `rapidoc` in the page for the interactive element. Types are in `src/index.d.ts`. The guide: [rapidocui.com/guides/prerender](https://rapidocui.com/guides/prerender/).
+
+## Development
+
+The renderer is in `src/` (its contract: `src/README.md`); the templates, components and styles it renders are in `packages/rapidoc/src`. `npm run build` bundles both into `dist/index.js`, with the third-party packages left external.