Getting started
The Scribe ATP SDK is now the SkyScribe SDK. The packages moved from @scribe-atp/* to @skyscribe-sdk/*. Only the package names changed: every function, hook, component, type and CSS class has the same name and behaves the same way, and the version numbers carry on from where the old packages left off.
The old packages still install and work, but they're deprecated and won't get any more updates.
Note
This page moves you to @skyscribe-sdk/* 4.x, where the names are unchanged. Version 5 then renamed the API to the site.standard terms; once you're on 4.x, follow Upgrading to 5.0.
| Old | New |
|---|---|
@scribe-atp/core | @skyscribe-sdk/core |
@scribe-atp/react | @skyscribe-sdk/react |
@scribe-atp/react-router-framework | @skyscribe-sdk/react-router-framework |
@scribe-atp/next | @skyscribe-sdk/next |
@scribe-atp/vue | @skyscribe-sdk/vue |
@scribe-atp/nuxt | @skyscribe-sdk/nuxt |
@scribe-atp/angular | @skyscribe-sdk/angular |
@scribe-atp/social | @skyscribe-sdk/social |
@scribe-atp/styles | @skyscribe-sdk/styles |
Uninstall the old packages and install the new ones. For example, a site using core and the React Router package:
npm uninstall @scribe-atp/core @scribe-atp/react-router-framework
npm install @skyscribe-sdk/core @skyscribe-sdk/react-router-framework
pnpm remove @scribe-atp/core @scribe-atp/react-router-framework
pnpm add @skyscribe-sdk/core @skyscribe-sdk/react-router-framework
yarn remove @scribe-atp/core @scribe-atp/react-router-framework
yarn add @skyscribe-sdk/core @skyscribe-sdk/react-router-framework
Replace @scribe-atp/ with @skyscribe-sdk/ everywhere in your source code, including CSS imports such as @scribe-atp/styles. In most projects one search-and-replace does it:
grep -rl "@scribe-atp/" src app | xargs sed -i 's#@scribe-atp/#@skyscribe-sdk/#g'
Adjust the folders for your project (on macOS, use sed -i ''). If you use Nuxt, also update the module name in nuxt.config.ts:
export default defineNuxtConfig({
modules: ['@skyscribe-sdk/nuxt'],
});
grep -rn "@scribe-atp/" --exclude-dir=node_modules .
This should only find your lockfile entries, if any, until you reinstall. Then build and run your tests as usual.
ScribeService, useScribeSite and <ScribeContent>.scribe-content wrapper and the social buttons' scribe-atp-like-button, scribe-atp-share-button and scribe-atp-subscribe-button classes. Your stylesheets keep working.localStorage keys used by the social buttons, so readers' saved likes and subscriptions carry over.social.skyscribe.app (the default from @skyscribe-sdk/social 1.6.0), and the old one redirects there.If something doesn't work after migrating, email hello@skyscribe.app.