From 6d499234bcc5e5cb60e61991c6d2cdb907f936dc Mon Sep 17 00:00:00 2001 From: christina Date: Mon, 23 Aug 2021 09:11:37 -0400 Subject: [PATCH] fix(docs): clarify index.html and config.yml files purpose (#5731) --- website/content/docs/add-to-your-site.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/docs/add-to-your-site.md b/website/content/docs/add-to-your-site.md index 51fbd958..629dc6a4 100755 --- a/website/content/docs/add-to-your-site.md +++ b/website/content/docs/add-to-your-site.md @@ -35,7 +35,9 @@ admin └ config.yml ``` -The first file, `admin/index.html`, is the entry point for the Netlify CMS admin interface. This means that users navigate to `yoursite.com/admin/` to access it. On the code side, it's a basic HTML starter page that loads the Netlify CMS JavaScript file. In this example, we pull the file from a public CDN: +The first file, `admin/index.html`, is the entry point for the Netlify CMS admin interface. This means that users navigate to `yoursite.com/admin/` to access it. On the code side, it's a basic HTML starter page that loads the Netlify CMS JavaScript file. The second file, `admin/config.yml`, is the heart of your Netlify CMS installation, and a bit more complex. The [Configuration](#configuration) section covers the details. + +In this example, we pull the `admin/index.html` file from a public CDN. ```html @@ -54,8 +56,6 @@ The first file, `admin/index.html`, is the entry point for the Netlify CMS admin In the code above the `script` is loaded from the `unpkg` CDN. Should there be any issue, `jsDelivr` can be used as an alternative source. Simply set the `src` to `https://cdn.jsdelivr.net/npm/netlify-cms@^2.0.0/dist/netlify-cms.js` -The second file, `admin/config.yml`, is the heart of your Netlify CMS installation, and a bit more complex. The [Configuration](#configuration) section covers the details. - ### Installing with npm You can also use Netlify CMS as an npm module. Wherever you import Netlify CMS, it automatically runs, taking over the current page. Make sure the script that imports it only runs on your CMS page. First install the package and save it to your project: