diff --git a/docs/_preview/.browserslistrc b/docs/_preview/.browserslistrc deleted file mode 100644 index e996378126..0000000000 --- a/docs/_preview/.browserslistrc +++ /dev/null @@ -1,3 +0,0 @@ -> 0.5% -last 2 versions -not dead diff --git a/docs/_preview/assets/scss/docs/_home.scss b/docs/_preview/assets/scss/docs/_home.scss deleted file mode 100644 index 3f5ad7b14d..0000000000 --- a/docs/_preview/assets/scss/docs/_home.scss +++ /dev/null @@ -1,64 +0,0 @@ -/*! - * Copyright 2025, TeamDev. All rights reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -.home { - background-color: $body-light-gray-color; - font-family: $main-font; - - .container { - background-color: white; - border: 1px solid #e6ecf1; - max-width: 760px; - padding: 48px 56px; - - @include breakpoint(md-phone) { - padding: 24px; - } - - h1 { - font-size: $font-size--xxxl; - font-weight: 300; - color: rgba(0, 0, 0, .4); - line-height: 1.2; - margin-bottom: 32px; - padding-top: 16px; - - @include breakpoint(md-phone) { - font-size: $font-size--xl; - } - } - - a { - color: $main-brand-color; - } - - .subtle { - color: rgba(0, 0, 0, .46); - margin-top: 40px; - font-size: 14px; - } - } -} diff --git a/docs/_preview/assets/scss/docs/_layout.scss b/docs/_preview/assets/scss/docs/_layout.scss deleted file mode 100644 index 88a7704040..0000000000 --- a/docs/_preview/assets/scss/docs/_layout.scss +++ /dev/null @@ -1,37 +0,0 @@ -/*! - * Copyright 2025, TeamDev. All rights reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -.page-content { - .three-column { - .sticky-col { - top: 0; - } - - .content-col { - padding-bottom: 20px; - } - } -} diff --git a/docs/_preview/assets/scss/main.scss b/docs/_preview/assets/scss/main.scss deleted file mode 100644 index f687a3b6d7..0000000000 --- a/docs/_preview/assets/scss/main.scss +++ /dev/null @@ -1,36 +0,0 @@ -/*! - * Copyright 2025, TeamDev. All rights reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -@import "node_modules/bootstrap/scss/bootstrap"; - -@import "docs-common"; -@import "docs"; - -// Styles that should only be used to build this site. -// They should not be imported into the main spine.io site -// to not override or duplicate styles there. -@import "docs/home"; -@import "docs/layout"; diff --git a/docs/_preview/content/docs/_index.md b/docs/_preview/content/_index.md similarity index 55% rename from docs/_preview/content/docs/_index.md rename to docs/_preview/content/_index.md index b35071d89d..84d6c9fecf 100644 --- a/docs/_preview/content/docs/_index.md +++ b/docs/_preview/content/_index.md @@ -4,11 +4,12 @@ title: Validation Documentation preview # Welcome to Validation Documentation -Go to the [docs/](docs/) to preview the rendered documentation. +Go to the [docs/validation/](docs/validation/00-intro/) to preview the rendered documentation. Read the [Authoring][authoring] guide on adding the content to the documentation. -

This page is only available on this preview site and will not be -rendered on spine.io.

+This page is only available on this preview site and will not be +rendered on [spine.io](https://spine.io). +{class="subtle"} [authoring]: https://github.com/SpineEventEngine/SpineEventEngine.github.io/blob/master/AUTHORING.md diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index b620f3f6e9..c40d1ccea7 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -2,4 +2,9 @@ module spine.io/validation/docs/preview go 1.25.6 -require github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127 // indirect +require ( + github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3 // indirect + github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect + github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 // indirect + github.com/twbs/bootstrap v5.3.8+incompatible // indirect +) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index c64c861829..0388cdb9f5 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,2 +1,9 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127 h1:uIbC8yEB3A/9g5HShNsBpqhmfRlxGpkWcDCbqWjCPH0= -github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3 h1:Fweb3jJxf9gpjKEBlOAAaFHzlju4qnGlxj/3UJaa7UA= +github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= +github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= +github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 h1:GZxx4Hc+yb0/t3/rau1j8XlAxLE4CyXns2fqQbyqWfs= +github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o= +github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/docs/_preview/hugo.toml b/docs/_preview/hugo.toml index 513371ff28..a4fa617048 100644 --- a/docs/_preview/hugo.toml +++ b/docs/_preview/hugo.toml @@ -6,56 +6,18 @@ disableKinds = ['taxonomy', 'term'] [module] # First theme has higher priority than later ones. [[module.imports]] - path = 'github.com/SpineEventEngine/site-commons' - + path = '../..' [[module.imports]] - path = 'github.com/SpineEventEngine/validation/docs' - [[module.imports.mounts]] - source = 'content' - target = 'content' - [[module.imports.mounts]] - source = 'layouts' - target = 'layouts' - [[module.imports.mounts]] - source = 'assets' - target = 'assets' - [[module.imports.mounts]] - source = 'static' - target = 'static' + path = 'github.com/SpineEventEngine/site-commons' # Enables HTML rendering in markdown files. [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true + [markup.goldmark.parser] + [markup.goldmark.parser.attribute] + block = true + title = true [markup.highlight] noClasses = false - -# Version control config. -# To change the current main version, update only the `path` parameter. -# Read more in the `SPINE_RELEASE.md` guide. -# -# The same settings should be copied to the `SpineEventEngine/SpineEventEngine.github.io` -# project due to the issue with the cascade arrays: -# https://github.com/gohugoio/hugo/issues/13869 -[[cascade]] - [cascade.params] - url = 'docs/' - [cascade.target] - # The path to the `_index.md` of the current main version. - path = '{/docs}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/' - [cascade.target] - # The path to the current main version. - path = '{/docs/**}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/:contentbasename/' - [cascade.target] - # The path to the current main version. - path = '{/docs/**}' - kind = 'page' diff --git a/docs/_preview/package-lock.json b/docs/_preview/package-lock.json index 0812faa820..c514573791 100644 --- a/docs/_preview/package-lock.json +++ b/docs/_preview/package-lock.json @@ -8,9 +8,6 @@ "name": "spine-docs", "version": "1.0.0", "license": "ISC", - "dependencies": { - "bootstrap": "^5.3.8" - }, "devDependencies": { "@fullhuman/postcss-purgecss": "^7.0.2", "autoprefixer": "^10.4.22", @@ -148,16 +145,6 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, - "node_modules/@popperjs/core": { - "version": "2.11.8", - "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz", - "integrity": "sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==", - "peer": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/popperjs" - } - }, "node_modules/ansi-regex": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", @@ -253,24 +240,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/bootstrap": { - "version": "5.3.8", - "resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-5.3.8.tgz", - "integrity": "sha512-HP1SZDqaLDPwsNiqRqi5NcP0SSXciX2s9E+RyqJIIqGo+vJeN5AJVM98CXmW/Wux0nQ5L7jeWUdplCEf0Ee+tg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/twbs" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/bootstrap" - } - ], - "peerDependencies": { - "@popperjs/core": "^2.11.8" - } - }, "node_modules/braces": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", diff --git a/docs/_preview/package.json b/docs/_preview/package.json index 343a8ff82b..143fef495c 100644 --- a/docs/_preview/package.json +++ b/docs/_preview/package.json @@ -14,8 +14,5 @@ "postcss": "^8.5.6", "postcss-cli": "^11.0.1", "postcss-discard-comments": "^7.0.5" - }, - "dependencies": { - "bootstrap": "^5.3.8" } } diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 0000000000..0b156267ec --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- diff --git a/docs/content/docs/_index.md b/docs/content/docs/_index.md new file mode 100644 index 0000000000..0b156267ec --- /dev/null +++ b/docs/content/docs/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- diff --git a/docs/content/docs/validation/00-intro/index.md b/docs/content/docs/validation/00-intro/_index.md similarity index 100% rename from docs/content/docs/validation/00-intro/index.md rename to docs/content/docs/validation/00-intro/_index.md diff --git a/docs/content/docs/validation/01-getting-started/index.md b/docs/content/docs/validation/01-getting-started/_index.md similarity index 100% rename from docs/content/docs/validation/01-getting-started/index.md rename to docs/content/docs/validation/01-getting-started/_index.md diff --git a/docs/content/docs/validation/_index.md b/docs/content/docs/validation/_index.md new file mode 100644 index 0000000000..0b156267ec --- /dev/null +++ b/docs/content/docs/validation/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- diff --git a/docs/content/docs/validation/developers-guide/_index.md b/docs/content/docs/validation/developers-guide/_index.md new file mode 100644 index 0000000000..0b156267ec --- /dev/null +++ b/docs/content/docs/validation/developers-guide/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- diff --git a/docs/data/docs/validation/2/sidenav.yml b/docs/data/docs/validation/2/sidenav.yml new file mode 100644 index 0000000000..9f96fdd714 --- /dev/null +++ b/docs/data/docs/validation/2/sidenav.yml @@ -0,0 +1,11 @@ +# The `file_path` should be relative to the `docs/validation`. +# Thanks to this, links to the version will be generated automatically. +# Also, the `file_path` must not end with a trailing slash. + +- page: Validation + key: validation + children: + - page: Overview + file_path: 00-intro + - page: Philosophy + file_path: 00-intro/philosophy diff --git a/docs/data/versions.yml b/docs/data/versions.yml new file mode 100644 index 0000000000..8fd4a8120a --- /dev/null +++ b/docs/data/versions.yml @@ -0,0 +1,9 @@ +validation: + - short: "2" + full: 2.0.0-SNAPSHOT + path: docs/validation + url: docs/validation + is_main: true + switcher: + visible: false + item_visible: false diff --git a/docs/hugo.toml b/docs/hugo.toml deleted file mode 100644 index 8648819953..0000000000 --- a/docs/hugo.toml +++ /dev/null @@ -1,6 +0,0 @@ -[params] - defaultCodeTheme = 'dark' - -# The third-party libraries from the `site-commons`. -[params.libs.js_cookie] - enabled = true