From 83f3b5052e935fc750a712502c39006b7024c2ec Mon Sep 17 00:00:00 2001 From: Xin <5097752+imfing@users.noreply.github.com> Date: Sat, 6 Sep 2025 12:06:26 +0100 Subject: [PATCH] chore(docs): rename `exampleSite` to `docs` and create `examples` (#813) * chore(docs): rename `exampleSite` to `docs` and create `examples` * chore(build): update build script to support new version format and source directories; add v0.10 to documentation menu --- .github/CONTRIBUTING.md | 6 +++--- CLAUDE.md | 10 +++++----- build.sh | 15 ++++++++------- dev.toml | 2 +- {exampleSite => docs}/assets/example.ipynb | 0 {exampleSite => docs}/assets/images/space.jpg | Bin {exampleSite => docs}/content/_index.fa.md | 0 {exampleSite => docs}/content/_index.ja.md | 0 {exampleSite => docs}/content/_index.md | 0 {exampleSite => docs}/content/_index.zh-cn.md | 0 {exampleSite => docs}/content/about/index.fa.md | 0 {exampleSite => docs}/content/about/index.ja.md | 0 {exampleSite => docs}/content/about/index.md | 0 .../content/about/index.zh-cn.md | 0 {exampleSite => docs}/content/blog/_index.fa.md | 0 {exampleSite => docs}/content/blog/_index.ja.md | 0 {exampleSite => docs}/content/blog/_index.md | 0 .../content/blog/_index.zh-cn.md | 0 .../content/blog/markdown.fa.md | 0 .../content/blog/markdown.ja.md | 0 {exampleSite => docs}/content/blog/markdown.md | 0 .../content/blog/markdown.zh-cn.md | 0 {exampleSite => docs}/content/blog/v0.10.fa.md | 0 {exampleSite => docs}/content/blog/v0.10.ja.md | 0 {exampleSite => docs}/content/blog/v0.10.md | 0 .../content/blog/v0.10.zh-cn.md | 0 {exampleSite => docs}/content/blog/v0.11.fa.md | 0 {exampleSite => docs}/content/blog/v0.11.ja.md | 0 {exampleSite => docs}/content/blog/v0.11.md | 0 .../content/blog/v0.11.zh-cn.md | 0 {exampleSite => docs}/content/docs/_index.fa.md | 0 {exampleSite => docs}/content/docs/_index.ja.md | 0 {exampleSite => docs}/content/docs/_index.md | 0 .../content/docs/_index.zh-cn.md | 0 .../content/docs/advanced/_index.fa.md | 0 .../content/docs/advanced/_index.ja.md | 0 .../content/docs/advanced/_index.md | 0 .../content/docs/advanced/_index.zh-cn.md | 0 .../content/docs/advanced/comments.fa.md | 0 .../content/docs/advanced/comments.ja.md | 0 .../content/docs/advanced/comments.md | 0 .../content/docs/advanced/comments.zh-cn.md | 0 .../content/docs/advanced/customization.fa.md | 0 .../content/docs/advanced/customization.ja.md | 0 .../content/docs/advanced/customization.md | 0 .../content/docs/advanced/customization.zh-cn.md | 0 .../content/docs/advanced/multi-language.fa.md | 0 .../content/docs/advanced/multi-language.ja.md | 0 .../content/docs/advanced/multi-language.md | 0 .../docs/advanced/multi-language.zh-cn.md | 0 .../content/docs/getting-started.fa.md | 0 .../content/docs/getting-started.ja.md | 0 .../content/docs/getting-started.md | 0 .../content/docs/getting-started.zh-cn.md | 0 .../content/docs/guide/_index.fa.md | 0 .../content/docs/guide/_index.ja.md | 0 .../content/docs/guide/_index.md | 0 .../content/docs/guide/_index.zh-cn.md | 0 .../content/docs/guide/configuration.fa.md | 4 ++-- .../content/docs/guide/configuration.ja.md | 4 ++-- .../content/docs/guide/configuration.md | 2 +- .../content/docs/guide/configuration.zh-cn.md | 4 ++-- .../content/docs/guide/deploy-site.fa.md | 0 .../content/docs/guide/deploy-site.ja.md | 0 .../content/docs/guide/deploy-site.md | 0 .../content/docs/guide/deploy-site.zh-cn.md | 0 .../content/docs/guide/diagrams.fa.md | 0 .../content/docs/guide/diagrams.ja.md | 0 .../content/docs/guide/diagrams.md | 0 .../content/docs/guide/diagrams.zh-cn.md | 0 .../content/docs/guide/latex.fa.md | 0 .../content/docs/guide/latex.ja.md | 0 .../content/docs/guide/latex.md | 0 .../content/docs/guide/latex.zh-cn.md | 0 .../content/docs/guide/markdown.fa.md | 0 .../content/docs/guide/markdown.ja.md | 0 .../content/docs/guide/markdown.md | 0 .../content/docs/guide/markdown.zh-cn.md | 0 .../content/docs/guide/organize-files.fa.md | 0 .../content/docs/guide/organize-files.ja.md | 0 .../content/docs/guide/organize-files.md | 0 .../content/docs/guide/organize-files.zh-cn.md | 0 .../content/docs/guide/shortcodes/_index.fa.md | 0 .../content/docs/guide/shortcodes/_index.ja.md | 0 .../content/docs/guide/shortcodes/_index.md | 0 .../docs/guide/shortcodes/_index.zh-cn.md | 0 .../docs/guide/shortcodes/asciinema.fa.md | 0 .../docs/guide/shortcodes/asciinema.ja.md | 0 .../content/docs/guide/shortcodes/asciinema.md | 0 .../docs/guide/shortcodes/asciinema.zh-cn.md | 0 .../content/docs/guide/shortcodes/callout.fa.md | 0 .../content/docs/guide/shortcodes/callout.ja.md | 0 .../content/docs/guide/shortcodes/callout.md | 0 .../docs/guide/shortcodes/callout.zh-cn.md | 0 .../content/docs/guide/shortcodes/cards.fa.md | 0 .../content/docs/guide/shortcodes/cards.ja.md | 0 .../content/docs/guide/shortcodes/cards.md | 0 .../content/docs/guide/shortcodes/cards.zh-cn.md | 0 .../content/docs/guide/shortcodes/details.fa.md | 0 .../content/docs/guide/shortcodes/details.ja.md | 0 .../content/docs/guide/shortcodes/details.md | 0 .../docs/guide/shortcodes/details.zh-cn.md | 0 .../content/docs/guide/shortcodes/filetree.fa.md | 0 .../content/docs/guide/shortcodes/filetree.ja.md | 0 .../content/docs/guide/shortcodes/filetree.md | 0 .../docs/guide/shortcodes/filetree.zh-cn.md | 0 .../content/docs/guide/shortcodes/hextra.fa.md | 0 .../content/docs/guide/shortcodes/hextra.ja.md | 0 .../content/docs/guide/shortcodes/hextra.md | 0 .../docs/guide/shortcodes/hextra.zh-cn.md | 0 .../content/docs/guide/shortcodes/icon.fa.md | 0 .../content/docs/guide/shortcodes/icon.ja.md | 0 .../content/docs/guide/shortcodes/icon.md | 0 .../content/docs/guide/shortcodes/icon.zh-cn.md | 0 .../content/docs/guide/shortcodes/jupyter.fa.md | 0 .../content/docs/guide/shortcodes/jupyter.ja.md | 0 .../content/docs/guide/shortcodes/jupyter.md | 0 .../docs/guide/shortcodes/jupyter.zh-cn.md | 0 .../content/docs/guide/shortcodes/others.fa.md | 0 .../content/docs/guide/shortcodes/others.ja.md | 0 .../content/docs/guide/shortcodes/others.md | 0 .../docs/guide/shortcodes/others.zh-cn.md | 0 .../content/docs/guide/shortcodes/steps.fa.md | 0 .../content/docs/guide/shortcodes/steps.ja.md | 0 .../content/docs/guide/shortcodes/steps.md | 0 .../content/docs/guide/shortcodes/steps.zh-cn.md | 0 .../content/docs/guide/shortcodes/tabs.fa.md | 0 .../content/docs/guide/shortcodes/tabs.ja.md | 0 .../content/docs/guide/shortcodes/tabs.md | 0 .../content/docs/guide/shortcodes/tabs.zh-cn.md | 0 .../content/docs/guide/syntax-highlighting.fa.md | 6 +++--- .../content/docs/guide/syntax-highlighting.ja.md | 6 +++--- .../content/docs/guide/syntax-highlighting.md | 4 ++-- .../docs/guide/syntax-highlighting.zh-cn.md | 6 +++--- .../content/showcase/index.fa.md | 0 .../content/showcase/index.ja.md | 0 {exampleSite => docs}/content/showcase/index.md | 0 .../content/showcase/index.zh-cn.md | 0 {exampleSite => docs}/go.mod | 2 +- {exampleSite => docs}/hugo.work | 0 {exampleSite => docs}/hugo.yaml | 7 ++++++- {exampleSite => docs}/hugo_stats.json | 0 {exampleSite => docs}/i18n/fa.yaml | 0 {exampleSite => docs}/i18n/ja.yaml | 0 {exampleSite => docs}/i18n/zh-cn.yaml | 0 .../layouts/_partials/custom/head-end.html | 0 .../layouts/_shortcodes/new-feature.html | 0 {exampleSite => docs}/static/favicon-dark.svg | 0 .../static/images/card-image-unprocessed.jpg | Bin .../static/images/hextra-doc.webp | Bin .../static/images/hextra-markdown.webp | Bin .../static/images/hextra-search.webp | Bin examples/README.md | 13 +++++++++++++ netlify.toml | 4 ++-- package.json | 6 +++--- taskfile.yaml | 4 ++-- 156 files changed, 62 insertions(+), 43 deletions(-) rename {exampleSite => docs}/assets/example.ipynb (100%) rename {exampleSite => docs}/assets/images/space.jpg (100%) rename {exampleSite => docs}/content/_index.fa.md (100%) rename {exampleSite => docs}/content/_index.ja.md (100%) rename {exampleSite => docs}/content/_index.md (100%) rename {exampleSite => docs}/content/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/about/index.fa.md (100%) rename {exampleSite => docs}/content/about/index.ja.md (100%) rename {exampleSite => docs}/content/about/index.md (100%) rename {exampleSite => docs}/content/about/index.zh-cn.md (100%) rename {exampleSite => docs}/content/blog/_index.fa.md (100%) rename {exampleSite => docs}/content/blog/_index.ja.md (100%) rename {exampleSite => docs}/content/blog/_index.md (100%) rename {exampleSite => docs}/content/blog/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/blog/markdown.fa.md (100%) rename {exampleSite => docs}/content/blog/markdown.ja.md (100%) rename {exampleSite => docs}/content/blog/markdown.md (100%) rename {exampleSite => docs}/content/blog/markdown.zh-cn.md (100%) rename {exampleSite => docs}/content/blog/v0.10.fa.md (100%) rename {exampleSite => docs}/content/blog/v0.10.ja.md (100%) rename {exampleSite => docs}/content/blog/v0.10.md (100%) rename {exampleSite => docs}/content/blog/v0.10.zh-cn.md (100%) rename {exampleSite => docs}/content/blog/v0.11.fa.md (100%) rename {exampleSite => docs}/content/blog/v0.11.ja.md (100%) rename {exampleSite => docs}/content/blog/v0.11.md (100%) rename {exampleSite => docs}/content/blog/v0.11.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/_index.fa.md (100%) rename {exampleSite => docs}/content/docs/_index.ja.md (100%) rename {exampleSite => docs}/content/docs/_index.md (100%) rename {exampleSite => docs}/content/docs/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/advanced/_index.fa.md (100%) rename {exampleSite => docs}/content/docs/advanced/_index.ja.md (100%) rename {exampleSite => docs}/content/docs/advanced/_index.md (100%) rename {exampleSite => docs}/content/docs/advanced/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/advanced/comments.fa.md (100%) rename {exampleSite => docs}/content/docs/advanced/comments.ja.md (100%) rename {exampleSite => docs}/content/docs/advanced/comments.md (100%) rename {exampleSite => docs}/content/docs/advanced/comments.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/advanced/customization.fa.md (100%) rename {exampleSite => docs}/content/docs/advanced/customization.ja.md (100%) rename {exampleSite => docs}/content/docs/advanced/customization.md (100%) rename {exampleSite => docs}/content/docs/advanced/customization.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/advanced/multi-language.fa.md (100%) rename {exampleSite => docs}/content/docs/advanced/multi-language.ja.md (100%) rename {exampleSite => docs}/content/docs/advanced/multi-language.md (100%) rename {exampleSite => docs}/content/docs/advanced/multi-language.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/getting-started.fa.md (100%) rename {exampleSite => docs}/content/docs/getting-started.ja.md (100%) rename {exampleSite => docs}/content/docs/getting-started.md (100%) rename {exampleSite => docs}/content/docs/getting-started.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/_index.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/_index.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/_index.md (100%) rename {exampleSite => docs}/content/docs/guide/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/configuration.fa.md (99%) rename {exampleSite => docs}/content/docs/guide/configuration.ja.md (99%) rename {exampleSite => docs}/content/docs/guide/configuration.md (98%) rename {exampleSite => docs}/content/docs/guide/configuration.zh-cn.md (98%) rename {exampleSite => docs}/content/docs/guide/deploy-site.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/deploy-site.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/deploy-site.md (100%) rename {exampleSite => docs}/content/docs/guide/deploy-site.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/diagrams.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/diagrams.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/diagrams.md (100%) rename {exampleSite => docs}/content/docs/guide/diagrams.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/latex.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/latex.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/latex.md (100%) rename {exampleSite => docs}/content/docs/guide/latex.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/markdown.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/markdown.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/markdown.md (100%) rename {exampleSite => docs}/content/docs/guide/markdown.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/organize-files.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/organize-files.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/organize-files.md (100%) rename {exampleSite => docs}/content/docs/guide/organize-files.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/_index.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/_index.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/_index.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/_index.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/asciinema.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/asciinema.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/asciinema.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/asciinema.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/callout.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/callout.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/callout.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/callout.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/cards.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/cards.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/cards.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/cards.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/details.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/details.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/details.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/details.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/filetree.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/filetree.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/filetree.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/filetree.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/hextra.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/hextra.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/hextra.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/hextra.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/icon.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/icon.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/icon.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/icon.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/jupyter.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/jupyter.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/jupyter.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/jupyter.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/others.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/others.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/others.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/others.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/steps.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/steps.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/steps.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/steps.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/tabs.fa.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/tabs.ja.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/tabs.md (100%) rename {exampleSite => docs}/content/docs/guide/shortcodes/tabs.zh-cn.md (100%) rename {exampleSite => docs}/content/docs/guide/syntax-highlighting.fa.md (97%) rename {exampleSite => docs}/content/docs/guide/syntax-highlighting.ja.md (96%) rename {exampleSite => docs}/content/docs/guide/syntax-highlighting.md (97%) rename {exampleSite => docs}/content/docs/guide/syntax-highlighting.zh-cn.md (95%) rename {exampleSite => docs}/content/showcase/index.fa.md (100%) rename {exampleSite => docs}/content/showcase/index.ja.md (100%) rename {exampleSite => docs}/content/showcase/index.md (100%) rename {exampleSite => docs}/content/showcase/index.zh-cn.md (100%) rename {exampleSite => docs}/go.mod (53%) rename {exampleSite => docs}/hugo.work (100%) rename {exampleSite => docs}/hugo.yaml (95%) rename {exampleSite => docs}/hugo_stats.json (100%) rename {exampleSite => docs}/i18n/fa.yaml (100%) rename {exampleSite => docs}/i18n/ja.yaml (100%) rename {exampleSite => docs}/i18n/zh-cn.yaml (100%) rename {exampleSite => docs}/layouts/_partials/custom/head-end.html (100%) rename {exampleSite => docs}/layouts/_shortcodes/new-feature.html (100%) rename {exampleSite => docs}/static/favicon-dark.svg (100%) rename {exampleSite => docs}/static/images/card-image-unprocessed.jpg (100%) rename {exampleSite => docs}/static/images/hextra-doc.webp (100%) rename {exampleSite => docs}/static/images/hextra-markdown.webp (100%) rename {exampleSite => docs}/static/images/hextra-search.webp (100%) create mode 100644 examples/README.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index edaa953..825bb06 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,7 +31,7 @@ Use [Conventional Commits][conventional commits] message to make it easier to un Similar to contributing code, you can also contribute to the documentation by submitting a pull request. -The documentation site is located in the [`exampleSite`](../exampleSite/) folder. +The documentation site is located in the [`docs`](../docs/) folder. You can make changes to the documentation and create a pull request. A preview of the new documentation will be automatically generated and displayed in the pull request comment via [Netlify][netlify deploy preview]. ### 💬 GitHub Discussions @@ -71,7 +71,7 @@ npm i - [`assets`](../assets/): CSS styles and JavaScript files. - [`data`](../data/): The theme data files. Now only contains the `icons.yaml` file. -- [`exampleSite`](../exampleSite/): The documentation site for the theme. +- [`docs`](../docs/): The documentation site for the theme. - [`i18n`](../i18n/): The theme translation files. - [`layouts`](../layouts/): The theme layouts. - [`static`](../static/): The static files for the theme. For example, the favicon and the site logo. @@ -84,7 +84,7 @@ Please refer to the [Hugo documentation][hugo] for more information. npm run dev:theme ``` -It will start the Hugo server on `http://localhost:1313/` for the `exampleSite` content. +It starts the Hugo server on `http://localhost:1313/` for the `docs` content. ### Compile the styles diff --git a/CLAUDE.md b/CLAUDE.md index 438a5f8..03487d5 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -84,12 +84,12 @@ assets/ ### Example Site Development -The `exampleSite/` directory serves as both documentation and testing ground: +The `docs/` directory serves as both documentation and testing ground: - Test new features here before releasing -- Configuration examples in `exampleSite/hugo.yaml` showing multi-language setup +- Configuration examples in `docs/hugo.yaml` showing multi-language setup - Content examples demonstrate all theme capabilities -- Run from exampleSite with: `hugo server --themesDir=../..` +- Run from docs with: `hugo server --themesDir=../..` ### CSS Development Workflow @@ -115,7 +115,7 @@ The `exampleSite/` directory serves as both documentation and testing ground: ### Key Configuration Files -- `exampleSite/hugo.yaml` - Example Hugo configuration with multi-language setup +- `docs/hugo.yaml` - Example Hugo configuration with multi-language setup - `postcss.config.mjs` - PostCSS configuration for CSS processing - `package.json` - Node.js dependencies and build scripts - `taskfile.yaml` - Task runner configuration @@ -155,7 +155,7 @@ The `exampleSite/` directory serves as both documentation and testing ground: ### Testing & Quality Assurance -- Test all changes in `exampleSite/` before releasing +- Test all changes in `docs/` before releasing - Use `npm run dev:theme` for theme development with hot reloading - Format code with `npx prettier --write .` before committing - Verify multi-language functionality across supported languages diff --git a/build.sh b/build.sh index 9568d99..60b7718 100755 --- a/build.sh +++ b/build.sh @@ -7,12 +7,13 @@ BASE_URL=${1:-"http://localhost:1313"} echo "Using base URL: $BASE_URL" # Version configuration - modify these arrays to specify versions to build -# Format: "ref:display_name" (ref can be tag, branch, or commit hash, display name is what will appear in URL) +# MAIN_VERSION format: "ref:display_name" +# VERSIONS format: "ref:display_name:source_dir" where source_dir is either "docs" or "exampleSite" MAIN_VERSION="v0.11.0:latest" VERSIONS=( - "main:latest" # latest version always builds from main - "v0.9.6:v0.9" - "v0.8.6:v0.8" + "main:latest:docs" # latest version always builds from main + "v0.10.2:v0.10:docs" + "v0.9.6:v0.9:exampleSite" ) # Parse main version @@ -29,13 +30,13 @@ GIT_HASH=$(git rev-parse --short HEAD) echo "Building main site from $MAIN_REF (commit: $GIT_HASH)" hugo \ --minify \ - --themesDir=../.. --source=exampleSite \ + --themesDir=../.. --source=docs \ --baseURL "$BASE_URL/" \ --destination=../public # Build all versions for VERSION in "${VERSIONS[@]}"; do - IFS=':' read -r REF NAME <<< "$VERSION" + IFS=':' read -r REF NAME DIR <<< "$VERSION" git checkout $REF GIT_HASH=$(git rev-parse --short HEAD) @@ -44,7 +45,7 @@ for VERSION in "${VERSIONS[@]}"; do mkdir -p "public/versions/$NAME" hugo \ --minify \ - --themesDir=../.. --source=exampleSite \ + --themesDir=../.. --source=$DIR \ --baseURL "$BASE_URL/versions/$NAME/" \ --destination="../public/versions/$NAME" done diff --git a/dev.toml b/dev.toml index 4bd0045..b56f91f 100644 --- a/dev.toml +++ b/dev.toml @@ -1,4 +1,4 @@ -# Theme development config for exampleSite +# Theme development config for documentation site # https://gohugo.io/configuration/build/#cache-busters [build] [build.buildStats] diff --git a/exampleSite/assets/example.ipynb b/docs/assets/example.ipynb similarity index 100% rename from exampleSite/assets/example.ipynb rename to docs/assets/example.ipynb diff --git a/exampleSite/assets/images/space.jpg b/docs/assets/images/space.jpg similarity index 100% rename from exampleSite/assets/images/space.jpg rename to docs/assets/images/space.jpg diff --git a/exampleSite/content/_index.fa.md b/docs/content/_index.fa.md similarity index 100% rename from exampleSite/content/_index.fa.md rename to docs/content/_index.fa.md diff --git a/exampleSite/content/_index.ja.md b/docs/content/_index.ja.md similarity index 100% rename from exampleSite/content/_index.ja.md rename to docs/content/_index.ja.md diff --git a/exampleSite/content/_index.md b/docs/content/_index.md similarity index 100% rename from exampleSite/content/_index.md rename to docs/content/_index.md diff --git a/exampleSite/content/_index.zh-cn.md b/docs/content/_index.zh-cn.md similarity index 100% rename from exampleSite/content/_index.zh-cn.md rename to docs/content/_index.zh-cn.md diff --git a/exampleSite/content/about/index.fa.md b/docs/content/about/index.fa.md similarity index 100% rename from exampleSite/content/about/index.fa.md rename to docs/content/about/index.fa.md diff --git a/exampleSite/content/about/index.ja.md b/docs/content/about/index.ja.md similarity index 100% rename from exampleSite/content/about/index.ja.md rename to docs/content/about/index.ja.md diff --git a/exampleSite/content/about/index.md b/docs/content/about/index.md similarity index 100% rename from exampleSite/content/about/index.md rename to docs/content/about/index.md diff --git a/exampleSite/content/about/index.zh-cn.md b/docs/content/about/index.zh-cn.md similarity index 100% rename from exampleSite/content/about/index.zh-cn.md rename to docs/content/about/index.zh-cn.md diff --git a/exampleSite/content/blog/_index.fa.md b/docs/content/blog/_index.fa.md similarity index 100% rename from exampleSite/content/blog/_index.fa.md rename to docs/content/blog/_index.fa.md diff --git a/exampleSite/content/blog/_index.ja.md b/docs/content/blog/_index.ja.md similarity index 100% rename from exampleSite/content/blog/_index.ja.md rename to docs/content/blog/_index.ja.md diff --git a/exampleSite/content/blog/_index.md b/docs/content/blog/_index.md similarity index 100% rename from exampleSite/content/blog/_index.md rename to docs/content/blog/_index.md diff --git a/exampleSite/content/blog/_index.zh-cn.md b/docs/content/blog/_index.zh-cn.md similarity index 100% rename from exampleSite/content/blog/_index.zh-cn.md rename to docs/content/blog/_index.zh-cn.md diff --git a/exampleSite/content/blog/markdown.fa.md b/docs/content/blog/markdown.fa.md similarity index 100% rename from exampleSite/content/blog/markdown.fa.md rename to docs/content/blog/markdown.fa.md diff --git a/exampleSite/content/blog/markdown.ja.md b/docs/content/blog/markdown.ja.md similarity index 100% rename from exampleSite/content/blog/markdown.ja.md rename to docs/content/blog/markdown.ja.md diff --git a/exampleSite/content/blog/markdown.md b/docs/content/blog/markdown.md similarity index 100% rename from exampleSite/content/blog/markdown.md rename to docs/content/blog/markdown.md diff --git a/exampleSite/content/blog/markdown.zh-cn.md b/docs/content/blog/markdown.zh-cn.md similarity index 100% rename from exampleSite/content/blog/markdown.zh-cn.md rename to docs/content/blog/markdown.zh-cn.md diff --git a/exampleSite/content/blog/v0.10.fa.md b/docs/content/blog/v0.10.fa.md similarity index 100% rename from exampleSite/content/blog/v0.10.fa.md rename to docs/content/blog/v0.10.fa.md diff --git a/exampleSite/content/blog/v0.10.ja.md b/docs/content/blog/v0.10.ja.md similarity index 100% rename from exampleSite/content/blog/v0.10.ja.md rename to docs/content/blog/v0.10.ja.md diff --git a/exampleSite/content/blog/v0.10.md b/docs/content/blog/v0.10.md similarity index 100% rename from exampleSite/content/blog/v0.10.md rename to docs/content/blog/v0.10.md diff --git a/exampleSite/content/blog/v0.10.zh-cn.md b/docs/content/blog/v0.10.zh-cn.md similarity index 100% rename from exampleSite/content/blog/v0.10.zh-cn.md rename to docs/content/blog/v0.10.zh-cn.md diff --git a/exampleSite/content/blog/v0.11.fa.md b/docs/content/blog/v0.11.fa.md similarity index 100% rename from exampleSite/content/blog/v0.11.fa.md rename to docs/content/blog/v0.11.fa.md diff --git a/exampleSite/content/blog/v0.11.ja.md b/docs/content/blog/v0.11.ja.md similarity index 100% rename from exampleSite/content/blog/v0.11.ja.md rename to docs/content/blog/v0.11.ja.md diff --git a/exampleSite/content/blog/v0.11.md b/docs/content/blog/v0.11.md similarity index 100% rename from exampleSite/content/blog/v0.11.md rename to docs/content/blog/v0.11.md diff --git a/exampleSite/content/blog/v0.11.zh-cn.md b/docs/content/blog/v0.11.zh-cn.md similarity index 100% rename from exampleSite/content/blog/v0.11.zh-cn.md rename to docs/content/blog/v0.11.zh-cn.md diff --git a/exampleSite/content/docs/_index.fa.md b/docs/content/docs/_index.fa.md similarity index 100% rename from exampleSite/content/docs/_index.fa.md rename to docs/content/docs/_index.fa.md diff --git a/exampleSite/content/docs/_index.ja.md b/docs/content/docs/_index.ja.md similarity index 100% rename from exampleSite/content/docs/_index.ja.md rename to docs/content/docs/_index.ja.md diff --git a/exampleSite/content/docs/_index.md b/docs/content/docs/_index.md similarity index 100% rename from exampleSite/content/docs/_index.md rename to docs/content/docs/_index.md diff --git a/exampleSite/content/docs/_index.zh-cn.md b/docs/content/docs/_index.zh-cn.md similarity index 100% rename from exampleSite/content/docs/_index.zh-cn.md rename to docs/content/docs/_index.zh-cn.md diff --git a/exampleSite/content/docs/advanced/_index.fa.md b/docs/content/docs/advanced/_index.fa.md similarity index 100% rename from exampleSite/content/docs/advanced/_index.fa.md rename to docs/content/docs/advanced/_index.fa.md diff --git a/exampleSite/content/docs/advanced/_index.ja.md b/docs/content/docs/advanced/_index.ja.md similarity index 100% rename from exampleSite/content/docs/advanced/_index.ja.md rename to docs/content/docs/advanced/_index.ja.md diff --git a/exampleSite/content/docs/advanced/_index.md b/docs/content/docs/advanced/_index.md similarity index 100% rename from exampleSite/content/docs/advanced/_index.md rename to docs/content/docs/advanced/_index.md diff --git a/exampleSite/content/docs/advanced/_index.zh-cn.md b/docs/content/docs/advanced/_index.zh-cn.md similarity index 100% rename from exampleSite/content/docs/advanced/_index.zh-cn.md rename to docs/content/docs/advanced/_index.zh-cn.md diff --git a/exampleSite/content/docs/advanced/comments.fa.md b/docs/content/docs/advanced/comments.fa.md similarity index 100% rename from exampleSite/content/docs/advanced/comments.fa.md rename to docs/content/docs/advanced/comments.fa.md diff --git a/exampleSite/content/docs/advanced/comments.ja.md b/docs/content/docs/advanced/comments.ja.md similarity index 100% rename from exampleSite/content/docs/advanced/comments.ja.md rename to docs/content/docs/advanced/comments.ja.md diff --git a/exampleSite/content/docs/advanced/comments.md b/docs/content/docs/advanced/comments.md similarity index 100% rename from exampleSite/content/docs/advanced/comments.md rename to docs/content/docs/advanced/comments.md diff --git a/exampleSite/content/docs/advanced/comments.zh-cn.md b/docs/content/docs/advanced/comments.zh-cn.md similarity index 100% rename from exampleSite/content/docs/advanced/comments.zh-cn.md rename to docs/content/docs/advanced/comments.zh-cn.md diff --git a/exampleSite/content/docs/advanced/customization.fa.md b/docs/content/docs/advanced/customization.fa.md similarity index 100% rename from exampleSite/content/docs/advanced/customization.fa.md rename to docs/content/docs/advanced/customization.fa.md diff --git a/exampleSite/content/docs/advanced/customization.ja.md b/docs/content/docs/advanced/customization.ja.md similarity index 100% rename from exampleSite/content/docs/advanced/customization.ja.md rename to docs/content/docs/advanced/customization.ja.md diff --git a/exampleSite/content/docs/advanced/customization.md b/docs/content/docs/advanced/customization.md similarity index 100% rename from exampleSite/content/docs/advanced/customization.md rename to docs/content/docs/advanced/customization.md diff --git a/exampleSite/content/docs/advanced/customization.zh-cn.md b/docs/content/docs/advanced/customization.zh-cn.md similarity index 100% rename from exampleSite/content/docs/advanced/customization.zh-cn.md rename to docs/content/docs/advanced/customization.zh-cn.md diff --git a/exampleSite/content/docs/advanced/multi-language.fa.md b/docs/content/docs/advanced/multi-language.fa.md similarity index 100% rename from exampleSite/content/docs/advanced/multi-language.fa.md rename to docs/content/docs/advanced/multi-language.fa.md diff --git a/exampleSite/content/docs/advanced/multi-language.ja.md b/docs/content/docs/advanced/multi-language.ja.md similarity index 100% rename from exampleSite/content/docs/advanced/multi-language.ja.md rename to docs/content/docs/advanced/multi-language.ja.md diff --git a/exampleSite/content/docs/advanced/multi-language.md b/docs/content/docs/advanced/multi-language.md similarity index 100% rename from exampleSite/content/docs/advanced/multi-language.md rename to docs/content/docs/advanced/multi-language.md diff --git a/exampleSite/content/docs/advanced/multi-language.zh-cn.md b/docs/content/docs/advanced/multi-language.zh-cn.md similarity index 100% rename from exampleSite/content/docs/advanced/multi-language.zh-cn.md rename to docs/content/docs/advanced/multi-language.zh-cn.md diff --git a/exampleSite/content/docs/getting-started.fa.md b/docs/content/docs/getting-started.fa.md similarity index 100% rename from exampleSite/content/docs/getting-started.fa.md rename to docs/content/docs/getting-started.fa.md diff --git a/exampleSite/content/docs/getting-started.ja.md b/docs/content/docs/getting-started.ja.md similarity index 100% rename from exampleSite/content/docs/getting-started.ja.md rename to docs/content/docs/getting-started.ja.md diff --git a/exampleSite/content/docs/getting-started.md b/docs/content/docs/getting-started.md similarity index 100% rename from exampleSite/content/docs/getting-started.md rename to docs/content/docs/getting-started.md diff --git a/exampleSite/content/docs/getting-started.zh-cn.md b/docs/content/docs/getting-started.zh-cn.md similarity index 100% rename from exampleSite/content/docs/getting-started.zh-cn.md rename to docs/content/docs/getting-started.zh-cn.md diff --git a/exampleSite/content/docs/guide/_index.fa.md b/docs/content/docs/guide/_index.fa.md similarity index 100% rename from exampleSite/content/docs/guide/_index.fa.md rename to docs/content/docs/guide/_index.fa.md diff --git a/exampleSite/content/docs/guide/_index.ja.md b/docs/content/docs/guide/_index.ja.md similarity index 100% rename from exampleSite/content/docs/guide/_index.ja.md rename to docs/content/docs/guide/_index.ja.md diff --git a/exampleSite/content/docs/guide/_index.md b/docs/content/docs/guide/_index.md similarity index 100% rename from exampleSite/content/docs/guide/_index.md rename to docs/content/docs/guide/_index.md diff --git a/exampleSite/content/docs/guide/_index.zh-cn.md b/docs/content/docs/guide/_index.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/_index.zh-cn.md rename to docs/content/docs/guide/_index.zh-cn.md diff --git a/exampleSite/content/docs/guide/configuration.fa.md b/docs/content/docs/guide/configuration.fa.md similarity index 99% rename from exampleSite/content/docs/guide/configuration.fa.md rename to docs/content/docs/guide/configuration.fa.md index 0d938f6..ded4d17 100644 --- a/exampleSite/content/docs/guide/configuration.fa.md +++ b/docs/content/docs/guide/configuration.fa.md @@ -7,7 +7,7 @@ tags: Hugo تنظیمات خود را از فایل `hugo.yaml` در ریشه سایت شما می‌خواند. فایل پیکربندی جایی است که می‌توانید تمام جنبه‌های سایت خود را تنظیم کنید. -برای آشنایی جامع با تنظیمات موجود و بهترین روش‌ها، فایل پیکربندی این سایت [`exampleSite/hugo.yaml`](https://github.com/imfing/hextra/blob/main/exampleSite/hugo.yaml) را در GitHub بررسی کنید. +برای آشنایی جامع با تنظیمات موجود و بهترین روش‌ها، فایل پیکربندی این سایت [`docs/hugo.yaml`](https://github.com/imfing/hextra/blob/main/docs/hugo.yaml) را در GitHub بررسی کنید. @@ -416,4 +416,4 @@ outputs: سایر ویژگی‌های Open Graph می‌توانند فقط یک مقدار داشته باشند. به عنوان مثال، این صفحه یک تگ `og:image` (که تصویری برای پیش‌نمایش در اشتراک‌گذاری‌های اجتماعی پیکربندی می‌کند) و یک تگ `og:audio` دارد. -```yaml {filename \ No newline at end of file +```yaml {filename diff --git a/exampleSite/content/docs/guide/configuration.ja.md b/docs/content/docs/guide/configuration.ja.md similarity index 99% rename from exampleSite/content/docs/guide/configuration.ja.md rename to docs/content/docs/guide/configuration.ja.md index 493b0dd..c2136c4 100644 --- a/exampleSite/content/docs/guide/configuration.ja.md +++ b/docs/content/docs/guide/configuration.ja.md @@ -7,7 +7,7 @@ tags: Hugo はサイトのルートにある `hugo.yaml` から設定を読み込みます。 この設定ファイルであなたのサイトのあらゆる側面を設定できます。 -利用可能な設定項目とベストプラクティスを網羅的に理解するには、GitHub 上のこのサイトの設定ファイル [`exampleSite/hugo.yaml`](https://github.com/imfing/hextra/blob/main/exampleSite/hugo.yaml) を参照してください。 +利用可能な設定項目とベストプラクティスを網羅的に理解するには、GitHub 上のこのサイトの設定ファイル [`docs/hugo.yaml`](https://github.com/imfing/hextra/blob/main/docs/hugo.yaml) を参照してください。 @@ -422,4 +422,4 @@ params: images: - "/img/config-image.jpg" audio: "config-talk.mp3" -``` \ No newline at end of file +``` diff --git a/exampleSite/content/docs/guide/configuration.md b/docs/content/docs/guide/configuration.md similarity index 98% rename from exampleSite/content/docs/guide/configuration.md rename to docs/content/docs/guide/configuration.md index 65eab61..05bbef4 100644 --- a/exampleSite/content/docs/guide/configuration.md +++ b/docs/content/docs/guide/configuration.md @@ -7,7 +7,7 @@ tags: Hugo reads its configuration from `hugo.yaml` in the root of your Hugo site. The config file is where you can configure all aspects of your site. -Check out the config file for this site [`exampleSite/hugo.yaml`](https://github.com/imfing/hextra/blob/main/exampleSite/hugo.yaml) on GitHub to get a comprehensive idea of available settings and best practices. +Check out the config file for this site [`docs/hugo.yaml`](https://github.com/imfing/hextra/blob/main/docs/hugo.yaml) on GitHub to get a comprehensive idea of available settings and best practices. diff --git a/exampleSite/content/docs/guide/configuration.zh-cn.md b/docs/content/docs/guide/configuration.zh-cn.md similarity index 98% rename from exampleSite/content/docs/guide/configuration.zh-cn.md rename to docs/content/docs/guide/configuration.zh-cn.md index 983bbe5..3efdd26 100644 --- a/exampleSite/content/docs/guide/configuration.zh-cn.md +++ b/docs/content/docs/guide/configuration.zh-cn.md @@ -7,7 +7,7 @@ tags: Hugo 从站点根目录的 `hugo.yaml` 读取配置。 配置文件可用来调整站点的所有方面。 -查看本网站的示例配置文件 [`exampleSite/hugo.yaml`](https://github.com/imfing/hextra/blob/main/exampleSite/hugo.yaml) 以全面了解可用设置和最佳实践。 +查看本网站的示例配置文件 [`docs/hugo.yaml`](https://github.com/imfing/hextra/blob/main/docs/hugo.yaml) 以全面了解可用设置和最佳实践。 @@ -422,4 +422,4 @@ params: images: - "/img/config-image.jpg" audio: "config-talk.mp3" -``` \ No newline at end of file +``` diff --git a/exampleSite/content/docs/guide/deploy-site.fa.md b/docs/content/docs/guide/deploy-site.fa.md similarity index 100% rename from exampleSite/content/docs/guide/deploy-site.fa.md rename to docs/content/docs/guide/deploy-site.fa.md diff --git a/exampleSite/content/docs/guide/deploy-site.ja.md b/docs/content/docs/guide/deploy-site.ja.md similarity index 100% rename from exampleSite/content/docs/guide/deploy-site.ja.md rename to docs/content/docs/guide/deploy-site.ja.md diff --git a/exampleSite/content/docs/guide/deploy-site.md b/docs/content/docs/guide/deploy-site.md similarity index 100% rename from exampleSite/content/docs/guide/deploy-site.md rename to docs/content/docs/guide/deploy-site.md diff --git a/exampleSite/content/docs/guide/deploy-site.zh-cn.md b/docs/content/docs/guide/deploy-site.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/deploy-site.zh-cn.md rename to docs/content/docs/guide/deploy-site.zh-cn.md diff --git a/exampleSite/content/docs/guide/diagrams.fa.md b/docs/content/docs/guide/diagrams.fa.md similarity index 100% rename from exampleSite/content/docs/guide/diagrams.fa.md rename to docs/content/docs/guide/diagrams.fa.md diff --git a/exampleSite/content/docs/guide/diagrams.ja.md b/docs/content/docs/guide/diagrams.ja.md similarity index 100% rename from exampleSite/content/docs/guide/diagrams.ja.md rename to docs/content/docs/guide/diagrams.ja.md diff --git a/exampleSite/content/docs/guide/diagrams.md b/docs/content/docs/guide/diagrams.md similarity index 100% rename from exampleSite/content/docs/guide/diagrams.md rename to docs/content/docs/guide/diagrams.md diff --git a/exampleSite/content/docs/guide/diagrams.zh-cn.md b/docs/content/docs/guide/diagrams.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/diagrams.zh-cn.md rename to docs/content/docs/guide/diagrams.zh-cn.md diff --git a/exampleSite/content/docs/guide/latex.fa.md b/docs/content/docs/guide/latex.fa.md similarity index 100% rename from exampleSite/content/docs/guide/latex.fa.md rename to docs/content/docs/guide/latex.fa.md diff --git a/exampleSite/content/docs/guide/latex.ja.md b/docs/content/docs/guide/latex.ja.md similarity index 100% rename from exampleSite/content/docs/guide/latex.ja.md rename to docs/content/docs/guide/latex.ja.md diff --git a/exampleSite/content/docs/guide/latex.md b/docs/content/docs/guide/latex.md similarity index 100% rename from exampleSite/content/docs/guide/latex.md rename to docs/content/docs/guide/latex.md diff --git a/exampleSite/content/docs/guide/latex.zh-cn.md b/docs/content/docs/guide/latex.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/latex.zh-cn.md rename to docs/content/docs/guide/latex.zh-cn.md diff --git a/exampleSite/content/docs/guide/markdown.fa.md b/docs/content/docs/guide/markdown.fa.md similarity index 100% rename from exampleSite/content/docs/guide/markdown.fa.md rename to docs/content/docs/guide/markdown.fa.md diff --git a/exampleSite/content/docs/guide/markdown.ja.md b/docs/content/docs/guide/markdown.ja.md similarity index 100% rename from exampleSite/content/docs/guide/markdown.ja.md rename to docs/content/docs/guide/markdown.ja.md diff --git a/exampleSite/content/docs/guide/markdown.md b/docs/content/docs/guide/markdown.md similarity index 100% rename from exampleSite/content/docs/guide/markdown.md rename to docs/content/docs/guide/markdown.md diff --git a/exampleSite/content/docs/guide/markdown.zh-cn.md b/docs/content/docs/guide/markdown.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/markdown.zh-cn.md rename to docs/content/docs/guide/markdown.zh-cn.md diff --git a/exampleSite/content/docs/guide/organize-files.fa.md b/docs/content/docs/guide/organize-files.fa.md similarity index 100% rename from exampleSite/content/docs/guide/organize-files.fa.md rename to docs/content/docs/guide/organize-files.fa.md diff --git a/exampleSite/content/docs/guide/organize-files.ja.md b/docs/content/docs/guide/organize-files.ja.md similarity index 100% rename from exampleSite/content/docs/guide/organize-files.ja.md rename to docs/content/docs/guide/organize-files.ja.md diff --git a/exampleSite/content/docs/guide/organize-files.md b/docs/content/docs/guide/organize-files.md similarity index 100% rename from exampleSite/content/docs/guide/organize-files.md rename to docs/content/docs/guide/organize-files.md diff --git a/exampleSite/content/docs/guide/organize-files.zh-cn.md b/docs/content/docs/guide/organize-files.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/organize-files.zh-cn.md rename to docs/content/docs/guide/organize-files.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/_index.fa.md b/docs/content/docs/guide/shortcodes/_index.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/_index.fa.md rename to docs/content/docs/guide/shortcodes/_index.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/_index.ja.md b/docs/content/docs/guide/shortcodes/_index.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/_index.ja.md rename to docs/content/docs/guide/shortcodes/_index.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/_index.md b/docs/content/docs/guide/shortcodes/_index.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/_index.md rename to docs/content/docs/guide/shortcodes/_index.md diff --git a/exampleSite/content/docs/guide/shortcodes/_index.zh-cn.md b/docs/content/docs/guide/shortcodes/_index.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/_index.zh-cn.md rename to docs/content/docs/guide/shortcodes/_index.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/asciinema.fa.md b/docs/content/docs/guide/shortcodes/asciinema.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/asciinema.fa.md rename to docs/content/docs/guide/shortcodes/asciinema.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/asciinema.ja.md b/docs/content/docs/guide/shortcodes/asciinema.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/asciinema.ja.md rename to docs/content/docs/guide/shortcodes/asciinema.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/asciinema.md b/docs/content/docs/guide/shortcodes/asciinema.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/asciinema.md rename to docs/content/docs/guide/shortcodes/asciinema.md diff --git a/exampleSite/content/docs/guide/shortcodes/asciinema.zh-cn.md b/docs/content/docs/guide/shortcodes/asciinema.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/asciinema.zh-cn.md rename to docs/content/docs/guide/shortcodes/asciinema.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/callout.fa.md b/docs/content/docs/guide/shortcodes/callout.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/callout.fa.md rename to docs/content/docs/guide/shortcodes/callout.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/callout.ja.md b/docs/content/docs/guide/shortcodes/callout.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/callout.ja.md rename to docs/content/docs/guide/shortcodes/callout.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/callout.md b/docs/content/docs/guide/shortcodes/callout.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/callout.md rename to docs/content/docs/guide/shortcodes/callout.md diff --git a/exampleSite/content/docs/guide/shortcodes/callout.zh-cn.md b/docs/content/docs/guide/shortcodes/callout.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/callout.zh-cn.md rename to docs/content/docs/guide/shortcodes/callout.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/cards.fa.md b/docs/content/docs/guide/shortcodes/cards.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/cards.fa.md rename to docs/content/docs/guide/shortcodes/cards.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/cards.ja.md b/docs/content/docs/guide/shortcodes/cards.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/cards.ja.md rename to docs/content/docs/guide/shortcodes/cards.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/cards.md b/docs/content/docs/guide/shortcodes/cards.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/cards.md rename to docs/content/docs/guide/shortcodes/cards.md diff --git a/exampleSite/content/docs/guide/shortcodes/cards.zh-cn.md b/docs/content/docs/guide/shortcodes/cards.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/cards.zh-cn.md rename to docs/content/docs/guide/shortcodes/cards.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/details.fa.md b/docs/content/docs/guide/shortcodes/details.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/details.fa.md rename to docs/content/docs/guide/shortcodes/details.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/details.ja.md b/docs/content/docs/guide/shortcodes/details.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/details.ja.md rename to docs/content/docs/guide/shortcodes/details.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/details.md b/docs/content/docs/guide/shortcodes/details.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/details.md rename to docs/content/docs/guide/shortcodes/details.md diff --git a/exampleSite/content/docs/guide/shortcodes/details.zh-cn.md b/docs/content/docs/guide/shortcodes/details.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/details.zh-cn.md rename to docs/content/docs/guide/shortcodes/details.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/filetree.fa.md b/docs/content/docs/guide/shortcodes/filetree.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/filetree.fa.md rename to docs/content/docs/guide/shortcodes/filetree.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/filetree.ja.md b/docs/content/docs/guide/shortcodes/filetree.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/filetree.ja.md rename to docs/content/docs/guide/shortcodes/filetree.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/filetree.md b/docs/content/docs/guide/shortcodes/filetree.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/filetree.md rename to docs/content/docs/guide/shortcodes/filetree.md diff --git a/exampleSite/content/docs/guide/shortcodes/filetree.zh-cn.md b/docs/content/docs/guide/shortcodes/filetree.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/filetree.zh-cn.md rename to docs/content/docs/guide/shortcodes/filetree.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/hextra.fa.md b/docs/content/docs/guide/shortcodes/hextra.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/hextra.fa.md rename to docs/content/docs/guide/shortcodes/hextra.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/hextra.ja.md b/docs/content/docs/guide/shortcodes/hextra.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/hextra.ja.md rename to docs/content/docs/guide/shortcodes/hextra.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/hextra.md b/docs/content/docs/guide/shortcodes/hextra.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/hextra.md rename to docs/content/docs/guide/shortcodes/hextra.md diff --git a/exampleSite/content/docs/guide/shortcodes/hextra.zh-cn.md b/docs/content/docs/guide/shortcodes/hextra.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/hextra.zh-cn.md rename to docs/content/docs/guide/shortcodes/hextra.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/icon.fa.md b/docs/content/docs/guide/shortcodes/icon.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/icon.fa.md rename to docs/content/docs/guide/shortcodes/icon.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/icon.ja.md b/docs/content/docs/guide/shortcodes/icon.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/icon.ja.md rename to docs/content/docs/guide/shortcodes/icon.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/icon.md b/docs/content/docs/guide/shortcodes/icon.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/icon.md rename to docs/content/docs/guide/shortcodes/icon.md diff --git a/exampleSite/content/docs/guide/shortcodes/icon.zh-cn.md b/docs/content/docs/guide/shortcodes/icon.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/icon.zh-cn.md rename to docs/content/docs/guide/shortcodes/icon.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/jupyter.fa.md b/docs/content/docs/guide/shortcodes/jupyter.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/jupyter.fa.md rename to docs/content/docs/guide/shortcodes/jupyter.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/jupyter.ja.md b/docs/content/docs/guide/shortcodes/jupyter.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/jupyter.ja.md rename to docs/content/docs/guide/shortcodes/jupyter.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/jupyter.md b/docs/content/docs/guide/shortcodes/jupyter.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/jupyter.md rename to docs/content/docs/guide/shortcodes/jupyter.md diff --git a/exampleSite/content/docs/guide/shortcodes/jupyter.zh-cn.md b/docs/content/docs/guide/shortcodes/jupyter.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/jupyter.zh-cn.md rename to docs/content/docs/guide/shortcodes/jupyter.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/others.fa.md b/docs/content/docs/guide/shortcodes/others.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/others.fa.md rename to docs/content/docs/guide/shortcodes/others.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/others.ja.md b/docs/content/docs/guide/shortcodes/others.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/others.ja.md rename to docs/content/docs/guide/shortcodes/others.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/others.md b/docs/content/docs/guide/shortcodes/others.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/others.md rename to docs/content/docs/guide/shortcodes/others.md diff --git a/exampleSite/content/docs/guide/shortcodes/others.zh-cn.md b/docs/content/docs/guide/shortcodes/others.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/others.zh-cn.md rename to docs/content/docs/guide/shortcodes/others.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/steps.fa.md b/docs/content/docs/guide/shortcodes/steps.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/steps.fa.md rename to docs/content/docs/guide/shortcodes/steps.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/steps.ja.md b/docs/content/docs/guide/shortcodes/steps.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/steps.ja.md rename to docs/content/docs/guide/shortcodes/steps.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/steps.md b/docs/content/docs/guide/shortcodes/steps.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/steps.md rename to docs/content/docs/guide/shortcodes/steps.md diff --git a/exampleSite/content/docs/guide/shortcodes/steps.zh-cn.md b/docs/content/docs/guide/shortcodes/steps.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/steps.zh-cn.md rename to docs/content/docs/guide/shortcodes/steps.zh-cn.md diff --git a/exampleSite/content/docs/guide/shortcodes/tabs.fa.md b/docs/content/docs/guide/shortcodes/tabs.fa.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/tabs.fa.md rename to docs/content/docs/guide/shortcodes/tabs.fa.md diff --git a/exampleSite/content/docs/guide/shortcodes/tabs.ja.md b/docs/content/docs/guide/shortcodes/tabs.ja.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/tabs.ja.md rename to docs/content/docs/guide/shortcodes/tabs.ja.md diff --git a/exampleSite/content/docs/guide/shortcodes/tabs.md b/docs/content/docs/guide/shortcodes/tabs.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/tabs.md rename to docs/content/docs/guide/shortcodes/tabs.md diff --git a/exampleSite/content/docs/guide/shortcodes/tabs.zh-cn.md b/docs/content/docs/guide/shortcodes/tabs.zh-cn.md similarity index 100% rename from exampleSite/content/docs/guide/shortcodes/tabs.zh-cn.md rename to docs/content/docs/guide/shortcodes/tabs.zh-cn.md diff --git a/exampleSite/content/docs/guide/syntax-highlighting.fa.md b/docs/content/docs/guide/syntax-highlighting.fa.md similarity index 97% rename from exampleSite/content/docs/guide/syntax-highlighting.fa.md rename to docs/content/docs/guide/syntax-highlighting.fa.md index ac538a3..914aac6 100644 --- a/exampleSite/content/docs/guide/syntax-highlighting.fa.md +++ b/docs/content/docs/guide/syntax-highlighting.fa.md @@ -49,12 +49,12 @@ def say_hello(): نام فایل می‌تواند شامل یک مسیر نسبی باشد اگر محل فایل را در مسیر پایه مشخص کند. ````markdown {filename="Markdown"} -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` ```` -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` @@ -111,4 +111,4 @@ params: ## زبان‌های پشتیبانی شده -برای مشاهده لیست زبان‌های پشتیبانی شده، لطفاً به [مستندات Chroma](https://github.com/alecthomas/chroma#supported-languages) مراجعه کنید. \ No newline at end of file +برای مشاهده لیست زبان‌های پشتیبانی شده، لطفاً به [مستندات Chroma](https://github.com/alecthomas/chroma#supported-languages) مراجعه کنید. diff --git a/exampleSite/content/docs/guide/syntax-highlighting.ja.md b/docs/content/docs/guide/syntax-highlighting.ja.md similarity index 96% rename from exampleSite/content/docs/guide/syntax-highlighting.ja.md rename to docs/content/docs/guide/syntax-highlighting.ja.md index adb2d5a..d388e99 100644 --- a/exampleSite/content/docs/guide/syntax-highlighting.ja.md +++ b/docs/content/docs/guide/syntax-highlighting.ja.md @@ -49,12 +49,12 @@ def say_hello(): ファイル名には、ベースパス内のファイルの場所を指定する相対パスを含めることができます。 ````markdown {filename="Markdown"} -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` ```` -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` @@ -111,4 +111,4 @@ params: ## 対応言語 -対応言語の一覧については、[Chroma のドキュメント](https://github.com/alecthomas/chroma#supported-languages)を参照してください。 \ No newline at end of file +対応言語の一覧については、[Chroma のドキュメント](https://github.com/alecthomas/chroma#supported-languages)を参照してください。 diff --git a/exampleSite/content/docs/guide/syntax-highlighting.md b/docs/content/docs/guide/syntax-highlighting.md similarity index 97% rename from exampleSite/content/docs/guide/syntax-highlighting.md rename to docs/content/docs/guide/syntax-highlighting.md index f129394..c7f9645 100644 --- a/exampleSite/content/docs/guide/syntax-highlighting.md +++ b/docs/content/docs/guide/syntax-highlighting.md @@ -49,12 +49,12 @@ You can use the `base_url` attribute to provide a base URL that will be combined The file name can include a relative path if it specifies the file's location within the base path. ````markdown {filename="Markdown"} -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` ```` -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` diff --git a/exampleSite/content/docs/guide/syntax-highlighting.zh-cn.md b/docs/content/docs/guide/syntax-highlighting.zh-cn.md similarity index 95% rename from exampleSite/content/docs/guide/syntax-highlighting.zh-cn.md rename to docs/content/docs/guide/syntax-highlighting.zh-cn.md index a51e406..4799f83 100644 --- a/exampleSite/content/docs/guide/syntax-highlighting.zh-cn.md +++ b/docs/content/docs/guide/syntax-highlighting.zh-cn.md @@ -46,12 +46,12 @@ def say_hello(): 通过 `base_url` 属性可设置基础 URL，该 URL 会与文件名组合生成可点击的链接。文件名可包含相对路径以指定文件在基础路径中的位置。 ````markdown {filename="Markdown"} -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` ```` -```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="exampleSite/hugo.work"} +```go {base_url="https://github.com/imfing/hextra/blob/main/",filename="docs/hugo.work"} go 1.20 ``` @@ -108,4 +108,4 @@ params: ## 支持语言 -完整支持的语言列表请参阅 [Chroma 文档](https://github.com/alecthomas/chroma#supported-languages)。 \ No newline at end of file +完整支持的语言列表请参阅 [Chroma 文档](https://github.com/alecthomas/chroma#supported-languages)。 diff --git a/exampleSite/content/showcase/index.fa.md b/docs/content/showcase/index.fa.md similarity index 100% rename from exampleSite/content/showcase/index.fa.md rename to docs/content/showcase/index.fa.md diff --git a/exampleSite/content/showcase/index.ja.md b/docs/content/showcase/index.ja.md similarity index 100% rename from exampleSite/content/showcase/index.ja.md rename to docs/content/showcase/index.ja.md diff --git a/exampleSite/content/showcase/index.md b/docs/content/showcase/index.md similarity index 100% rename from exampleSite/content/showcase/index.md rename to docs/content/showcase/index.md diff --git a/exampleSite/content/showcase/index.zh-cn.md b/docs/content/showcase/index.zh-cn.md similarity index 100% rename from exampleSite/content/showcase/index.zh-cn.md rename to docs/content/showcase/index.zh-cn.md diff --git a/exampleSite/go.mod b/docs/go.mod similarity index 53% rename from exampleSite/go.mod rename to docs/go.mod index 1ef2caa..9f416d6 100644 --- a/exampleSite/go.mod +++ b/docs/go.mod @@ -1,4 +1,4 @@ -module github.com/imfing/hextra/exampleSite +module github.com/imfing/hextra/docs go 1.20 diff --git a/exampleSite/hugo.work b/docs/hugo.work similarity index 100% rename from exampleSite/hugo.work rename to docs/hugo.work diff --git a/exampleSite/hugo.yaml b/docs/hugo.yaml similarity index 95% rename from exampleSite/hugo.yaml rename to docs/hugo.yaml index 22a3260..578d10e 100644 --- a/exampleSite/hugo.yaml +++ b/docs/hugo.yaml @@ -116,6 +116,11 @@ menu: params: type: link icon: beaker + parent: versions + - identifier: v0.10 + name: v0.10 ↗ + url: https://imfing.github.io/hextra/versions/v0.10/ + parent: versions - identifier: v0.9 name: v0.9 ↗ url: https://imfing.github.io/hextra/versions/v0.9/ @@ -187,7 +192,7 @@ params: editURL: enable: true - base: "https://github.com/imfing/hextra/edit/main/exampleSite/content" + base: "https://github.com/imfing/hextra/edit/main/docs/content" blog: list: diff --git a/exampleSite/hugo_stats.json b/docs/hugo_stats.json similarity index 100% rename from exampleSite/hugo_stats.json rename to docs/hugo_stats.json diff --git a/exampleSite/i18n/fa.yaml b/docs/i18n/fa.yaml similarity index 100% rename from exampleSite/i18n/fa.yaml rename to docs/i18n/fa.yaml diff --git a/exampleSite/i18n/ja.yaml b/docs/i18n/ja.yaml similarity index 100% rename from exampleSite/i18n/ja.yaml rename to docs/i18n/ja.yaml diff --git a/exampleSite/i18n/zh-cn.yaml b/docs/i18n/zh-cn.yaml similarity index 100% rename from exampleSite/i18n/zh-cn.yaml rename to docs/i18n/zh-cn.yaml diff --git a/exampleSite/layouts/_partials/custom/head-end.html b/docs/layouts/_partials/custom/head-end.html similarity index 100% rename from exampleSite/layouts/_partials/custom/head-end.html rename to docs/layouts/_partials/custom/head-end.html diff --git a/exampleSite/layouts/_shortcodes/new-feature.html b/docs/layouts/_shortcodes/new-feature.html similarity index 100% rename from exampleSite/layouts/_shortcodes/new-feature.html rename to docs/layouts/_shortcodes/new-feature.html diff --git a/exampleSite/static/favicon-dark.svg b/docs/static/favicon-dark.svg similarity index 100% rename from exampleSite/static/favicon-dark.svg rename to docs/static/favicon-dark.svg diff --git a/exampleSite/static/images/card-image-unprocessed.jpg b/docs/static/images/card-image-unprocessed.jpg similarity index 100% rename from exampleSite/static/images/card-image-unprocessed.jpg rename to docs/static/images/card-image-unprocessed.jpg diff --git a/exampleSite/static/images/hextra-doc.webp b/docs/static/images/hextra-doc.webp similarity index 100% rename from exampleSite/static/images/hextra-doc.webp rename to docs/static/images/hextra-doc.webp diff --git a/exampleSite/static/images/hextra-markdown.webp b/docs/static/images/hextra-markdown.webp similarity index 100% rename from exampleSite/static/images/hextra-markdown.webp rename to docs/static/images/hextra-markdown.webp diff --git a/exampleSite/static/images/hextra-search.webp b/docs/static/images/hextra-search.webp similarity index 100% rename from exampleSite/static/images/hextra-search.webp rename to docs/static/images/hextra-search.webp diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..3ae0b4f --- /dev/null +++ b/examples/README.md @@ -0,0 +1,13 @@ +# Examples + +This folder will host boilerplate example sites demonstrating Hextra for different use-cases. + +Planned examples: +- docs/ (minimal docs boilerplate) +- blog/ (blog-centric setup) +- portfolio/ (personal site/portfolio) + +Each example will include: +- A ready-to-run Hugo site +- Recommended config and params +- Customizations and best practices diff --git a/netlify.toml b/netlify.toml index 0065fc3..462e20d 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,6 +1,6 @@ [build] -publish = "exampleSite/public" -command = "cd exampleSite && hugo --gc --minify --themesDir ../.. -b ${DEPLOY_PRIME_URL}" +publish = "docs/public" +command = "cd docs && hugo --gc --minify --themesDir ../.. -b ${DEPLOY_PRIME_URL}" # Always trigger a rebuild, even if the files haven't changed. # See https://docs.netlify.com/configure-builds/file-based-configuration/#ignore-builds diff --git a/package.json b/package.json index 2145600..ef195cd 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { "scripts": { - "dev:theme": "hugo server --logLevel=debug --config=hugo.yaml,../dev.toml --environment=theme --source=exampleSite --themesDir=../.. -D -F --port 1313", - "dev": "hugo server --source=exampleSite --themesDir=../.. --disableFastRender -D --port 1313", + "dev:theme": "hugo server --logLevel=debug --config=hugo.yaml,../dev.toml --environment=theme --source=docs --themesDir=../.. -D -F --port 1313", + "dev": "hugo server --source=docs --themesDir=../.. --disableFastRender -D --port 1313", "build:css": "npx postcss --config postcss.config.mjs --env production assets/css/styles.css -o assets/css/compiled/main.css", - "build": "hugo --gc --minify --themesDir=../.. --source=exampleSite" + "build": "hugo --gc --minify --themesDir=../.. --source=docs" }, "devDependencies": { "@tailwindcss/postcss": "^4.1.11", diff --git a/taskfile.yaml b/taskfile.yaml index e901c68..4578676 100644 --- a/taskfile.yaml +++ b/taskfile.yaml @@ -2,9 +2,9 @@ version: "3" tasks: build: - desc: Build Hextra documentation site under `exampleSite` + desc: Build Hextra documentation site under `docs` cmds: - - hugo --gc --minify --themesDir=../.. --source=exampleSite + - hugo --gc --minify --themesDir=../.. --source=docs css: depends: [build]