static-cms/website/content/docs/site-generator-overview.mdx

35 lines
1.7 KiB
Plaintext
Raw Normal View History

2022-09-30 11:39:35 -04:00
---
group: Guides
title: Overview
2022-09-30 11:39:35 -04:00
weight: 1
---
2022-10-02 20:06:20 -04:00
The process for adding Static CMS to a static site can be divided into four main steps:
2022-09-30 11:39:35 -04:00
2022-10-30 10:38:28 -04:00
## Install Static CMS
2022-09-30 11:39:35 -04:00
This is a single page app available at the `/admin` route of your website.
Check out the [general overview](/docs/intro/) to see what the installation process entails.
2022-10-30 10:38:28 -04:00
## Set up a backend
2022-09-30 11:39:35 -04:00
2022-10-02 20:06:20 -04:00
This serves two purpose: Secure access to your website's Static CMS and allows it to read and update content files in your repo. More information about configuring the backend can be found [here](/docs/backends-overview/).
2022-09-30 11:39:35 -04:00
2022-10-30 10:38:28 -04:00
## Configure Static CMS using a configuration file
2022-09-30 11:39:35 -04:00
For starters, you can get by with a basic configuration that includes required information like Git provider, branch and folders to save files to.
Once you've gotten the hang of it, you can use the file to build whatever collections and content modeling you want. Check out the [this section](/docs/configuration-options/#configuration-file) for full details about all available configuration options.
2022-10-30 10:38:28 -04:00
## Render the content provided by Static CMS as web pages
2022-09-30 11:39:35 -04:00
2022-10-02 20:06:20 -04:00
Static CMS manages your content, and provides admin features, but it doesn't deliver content. It only makes your content available through an API.
2022-09-30 11:39:35 -04:00
It is up to developers to determine how to build the raw content into something useful and delightful on the frontend.
2022-10-02 20:06:20 -04:00
To learn how to query raw content managed by Static CMS and reformat them for delivery to end users, please refer the dedicated section for your site generator in the Table of Content.
2022-10-30 10:38:28 -04:00
## Local development
2022-09-30 11:39:35 -04:00
2022-11-07 10:44:42 -05:00
If you are experimenting with Static CMS or testing things out, you can connect it to a local Git repository instead of a live one. Learn how to do it [here](/docs/local-backend).