Update README.md

This commit is contained in:
lightling 2024-05-02 21:02:39 -04:00
parent 45017c3a41
commit ded87049f5

View file

@ -14,9 +14,9 @@ TBA
Make sure you have node installed on your machine. The best way to manage node is to use [nvm](https://github.com/nvm-sh/nvm) ([windows version](https://github.com/coreybutler/nvm-windows)). This project uses `.nvmrc` to inform `nvm` of the targeted (ideal) version to use. Running `nvm install {version-in-nvmrc}` will install the appropriate version, and running `nvm use` in every terminal session will keep node in sync with `.nvmrc` (if the version is not installed, `nvm` will tell you what version to install). Once node is installed, run `npm ci` in a terminal to install the dependencies used by the project.
### Content
### Site Content
You will need to create a folder `/content` (ignored by `git`), add the basic site config to it, and have some sort of content in order for the site to generate. See [Architecture](#architecture) for more information.
You will need to create a site folder in `/projects/sites/<site-name>` (ignored by `git`), add the basic site config to it, and have some sort of content in order for the site to generate. Before previewing the site, run `npm run set-current -w=sites --site=<site-name>` so that the site is linked to the frontend. See [Architecture](#architecture) for more information.
### Live Preview