From 7b1e68374f22848493be8fefb30fefcde59bf336 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 5 Feb 2026 12:07:53 +0100 Subject: [PATCH] Rename the `_site` directory to the `_preview` --- .gitignore | 6 +++--- README.md | 8 ++++---- docs/{_site => _preview}/.browserslistrc | 0 docs/{_site => _preview}/assets/scss/docs/_home.scss | 0 docs/{_site => _preview}/assets/scss/docs/_layout.scss | 0 docs/{_site => _preview}/assets/scss/main.scss | 0 docs/{_site => _preview}/config/_default/hugo.toml | 0 docs/{_site => _preview}/content/_index.md | 0 docs/{_site => _preview}/go.mod | 0 docs/{_site => _preview}/go.sum | 0 docs/{_site => _preview}/layouts/_default/baseof.html | 0 docs/{_site => _preview}/layouts/_default/page.html | 0 docs/{_site => _preview}/layouts/_default/section.html | 0 docs/{_site => _preview}/layouts/_partials/head/head.html | 0 .../layouts/_partials/head/stylesheet.html | 0 .../{_site => _preview}/layouts/_partials/head/title.html | 0 .../layouts/_partials/scripts/body-scripts.html | 0 .../layouts/_partials/scripts/head-scripts.html | 0 docs/{_site => _preview}/layouts/index.html | 0 docs/{_site => _preview}/package-lock.json | 0 docs/{_site => _preview}/package.json | 0 docs/{_site => _preview}/postcss.config.js | 0 docs/_script/hugo-build | 2 +- docs/_script/hugo-serve | 2 +- docs/_script/install-dependencies | 2 +- 25 files changed, 10 insertions(+), 10 deletions(-) rename docs/{_site => _preview}/.browserslistrc (100%) rename docs/{_site => _preview}/assets/scss/docs/_home.scss (100%) rename docs/{_site => _preview}/assets/scss/docs/_layout.scss (100%) rename docs/{_site => _preview}/assets/scss/main.scss (100%) rename docs/{_site => _preview}/config/_default/hugo.toml (100%) rename docs/{_site => _preview}/content/_index.md (100%) rename docs/{_site => _preview}/go.mod (100%) rename docs/{_site => _preview}/go.sum (100%) rename docs/{_site => _preview}/layouts/_default/baseof.html (100%) rename docs/{_site => _preview}/layouts/_default/page.html (100%) rename docs/{_site => _preview}/layouts/_default/section.html (100%) rename docs/{_site => _preview}/layouts/_partials/head/head.html (100%) rename docs/{_site => _preview}/layouts/_partials/head/stylesheet.html (100%) rename docs/{_site => _preview}/layouts/_partials/head/title.html (100%) rename docs/{_site => _preview}/layouts/_partials/scripts/body-scripts.html (100%) rename docs/{_site => _preview}/layouts/_partials/scripts/head-scripts.html (100%) rename docs/{_site => _preview}/layouts/index.html (100%) rename docs/{_site => _preview}/package-lock.json (100%) rename docs/{_site => _preview}/package.json (100%) rename docs/{_site => _preview}/postcss.config.js (100%) diff --git a/.gitignore b/.gitignore index 36c4d07..1c21d74 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,15 @@ # Hugo cache files -docs/_site/resources +docs/_preview/resources public # Cache folder for Hugo Modules -docs/_site/_vendor +docs/_preview/_vendor # Node modules node_modules # Used to control concurrency between multiple Hugo instances -docs/_site/.hugo_build.lock +docs/_preview/.hugo_build.lock # Needed for navigation/intellisense help inside code editors jsconfig.json diff --git a/README.md b/README.md index 79e1e55..74eac1f 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The project has two directories: * `docs` – contains the documentation files along with all the necessary JS and CSS files. This directory will be added to `SpineEventEngine/SpineEventEngine.github.io` as a Hugo Module. -* `docs/_site` – contains the HTML and CSS files needed only to run the +* `docs/_preview` – contains the HTML and CSS files needed only to run the documentation locally. To build and launch the site on the local server: @@ -53,7 +53,7 @@ To build the site without running the server: Another way to run the site locally is to follow these steps: -1. Navigate to the `docs/_site` folder. +1. Navigate to the `docs/_preview` folder. 2. Start the local server with this command: ```shell @@ -80,7 +80,7 @@ be updated in the main `spine.io` site repository. To get theme updates: -1. Navigate to the `docs/_site` directory. +1. Navigate to the `docs/_preview` directory. 2. Clean the module cache: ```shell @@ -142,7 +142,7 @@ There are two main import files: Should be imported into the `main.scss` of the `spine.io` site as well. Styles needed only for running the documentation locally are located -in `docs/_site/assets/scss`. They will not be available on `spine.io`. +in `docs/_preview/assets/scss`. They will not be available on `spine.io`. ## Troubleshooting diff --git a/docs/_site/.browserslistrc b/docs/_preview/.browserslistrc similarity index 100% rename from docs/_site/.browserslistrc rename to docs/_preview/.browserslistrc diff --git a/docs/_site/assets/scss/docs/_home.scss b/docs/_preview/assets/scss/docs/_home.scss similarity index 100% rename from docs/_site/assets/scss/docs/_home.scss rename to docs/_preview/assets/scss/docs/_home.scss diff --git a/docs/_site/assets/scss/docs/_layout.scss b/docs/_preview/assets/scss/docs/_layout.scss similarity index 100% rename from docs/_site/assets/scss/docs/_layout.scss rename to docs/_preview/assets/scss/docs/_layout.scss diff --git a/docs/_site/assets/scss/main.scss b/docs/_preview/assets/scss/main.scss similarity index 100% rename from docs/_site/assets/scss/main.scss rename to docs/_preview/assets/scss/main.scss diff --git a/docs/_site/config/_default/hugo.toml b/docs/_preview/config/_default/hugo.toml similarity index 100% rename from docs/_site/config/_default/hugo.toml rename to docs/_preview/config/_default/hugo.toml diff --git a/docs/_site/content/_index.md b/docs/_preview/content/_index.md similarity index 100% rename from docs/_site/content/_index.md rename to docs/_preview/content/_index.md diff --git a/docs/_site/go.mod b/docs/_preview/go.mod similarity index 100% rename from docs/_site/go.mod rename to docs/_preview/go.mod diff --git a/docs/_site/go.sum b/docs/_preview/go.sum similarity index 100% rename from docs/_site/go.sum rename to docs/_preview/go.sum diff --git a/docs/_site/layouts/_default/baseof.html b/docs/_preview/layouts/_default/baseof.html similarity index 100% rename from docs/_site/layouts/_default/baseof.html rename to docs/_preview/layouts/_default/baseof.html diff --git a/docs/_site/layouts/_default/page.html b/docs/_preview/layouts/_default/page.html similarity index 100% rename from docs/_site/layouts/_default/page.html rename to docs/_preview/layouts/_default/page.html diff --git a/docs/_site/layouts/_default/section.html b/docs/_preview/layouts/_default/section.html similarity index 100% rename from docs/_site/layouts/_default/section.html rename to docs/_preview/layouts/_default/section.html diff --git a/docs/_site/layouts/_partials/head/head.html b/docs/_preview/layouts/_partials/head/head.html similarity index 100% rename from docs/_site/layouts/_partials/head/head.html rename to docs/_preview/layouts/_partials/head/head.html diff --git a/docs/_site/layouts/_partials/head/stylesheet.html b/docs/_preview/layouts/_partials/head/stylesheet.html similarity index 100% rename from docs/_site/layouts/_partials/head/stylesheet.html rename to docs/_preview/layouts/_partials/head/stylesheet.html diff --git a/docs/_site/layouts/_partials/head/title.html b/docs/_preview/layouts/_partials/head/title.html similarity index 100% rename from docs/_site/layouts/_partials/head/title.html rename to docs/_preview/layouts/_partials/head/title.html diff --git a/docs/_site/layouts/_partials/scripts/body-scripts.html b/docs/_preview/layouts/_partials/scripts/body-scripts.html similarity index 100% rename from docs/_site/layouts/_partials/scripts/body-scripts.html rename to docs/_preview/layouts/_partials/scripts/body-scripts.html diff --git a/docs/_site/layouts/_partials/scripts/head-scripts.html b/docs/_preview/layouts/_partials/scripts/head-scripts.html similarity index 100% rename from docs/_site/layouts/_partials/scripts/head-scripts.html rename to docs/_preview/layouts/_partials/scripts/head-scripts.html diff --git a/docs/_site/layouts/index.html b/docs/_preview/layouts/index.html similarity index 100% rename from docs/_site/layouts/index.html rename to docs/_preview/layouts/index.html diff --git a/docs/_site/package-lock.json b/docs/_preview/package-lock.json similarity index 100% rename from docs/_site/package-lock.json rename to docs/_preview/package-lock.json diff --git a/docs/_site/package.json b/docs/_preview/package.json similarity index 100% rename from docs/_site/package.json rename to docs/_preview/package.json diff --git a/docs/_site/postcss.config.js b/docs/_preview/postcss.config.js similarity index 100% rename from docs/_site/postcss.config.js rename to docs/_preview/postcss.config.js diff --git a/docs/_script/hugo-build b/docs/_script/hugo-build index 1694e90..d251ba2 100755 --- a/docs/_script/hugo-build +++ b/docs/_script/hugo-build @@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd docs/_site +cd docs/_preview hugo diff --git a/docs/_script/hugo-serve b/docs/_script/hugo-serve index b450ca6..943c491 100755 --- a/docs/_script/hugo-serve +++ b/docs/_script/hugo-serve @@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd docs/_site +cd docs/_preview hugo server diff --git a/docs/_script/install-dependencies b/docs/_script/install-dependencies index e93b86d..7bf873d 100755 --- a/docs/_script/install-dependencies +++ b/docs/_script/install-dependencies @@ -38,5 +38,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd docs/_site +cd docs/_preview npm install