Skip to content
This repository was archived by the owner on Sep 9, 2024. It is now read-only.

Commit ae243ee

Browse files
committed
docs: add platform and local dev notes to migration guide
1 parent d5d46d4 commit ae243ee

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

packages/docs/content/docs/netlify-cms-migration-guide.mdx

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ To migrate, simply replace Netlify CMS with Static CMS, then address the changes
1414

1515
Netlify CMS:
1616

17-
```js
17+
```html
1818
<script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
1919
```
2020

2121
Static CMS:
2222

23-
```js
23+
```html
2424
<script src="https://unpkg.com/@staticcms/app@^1.0.0/dist/static-cms-app.js"></script>
2525
```
2626

@@ -93,3 +93,33 @@ import CMS from '@staticcms/core';
9393
## Beta Features
9494

9595
All beta features from Netlify CMS that were kept, remain in beta and may not fully function in their current state. Please [submit an issue](https://github.com/StaticJsCMS/static-cms/issues) for any bugs you find.
96+
97+
## Platform Changes
98+
99+
### Gatsby
100+
101+
If you are using Gatsby you will need to change out your CMS plugin.
102+
103+
```bash
104+
# Uninstall Netlify CMS plugin
105+
npm uninstall gatsby-plugin-netlify-cms
106+
107+
# Install Static CMS plugin
108+
npm install gatsby-plugin-static-cms
109+
```
110+
111+
## Local Development Changes
112+
113+
If you are using the local backend you will need to switch the proxy server package you are using.
114+
115+
Netlify CMS:
116+
117+
```bash
118+
npx netlify-cms-proxy-server
119+
```
120+
121+
Static CMS:
122+
123+
```bash
124+
npx @staticcms/proxy-server
125+
```

packages/docs/src/pages/_app.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ require('prismjs/components/prism-toml');
2525
require('prismjs/components/prism-markup-templating');
2626
require('prismjs/components/prism-handlebars');
2727
require('prismjs/components/prism-markdown');
28+
require('prismjs/components/prism-bash');
2829

2930
function MyApp({ Component, pageProps }: AppProps) {
3031
const [mode, setMode] = useState<PaletteMode>('dark');

0 commit comments

Comments
 (0)