diff --git a/.github/workflows/event-dispatcher.yml b/.github/workflows/event-dispatcher.yml index 628988248..518c53954 100644 --- a/.github/workflows/event-dispatcher.yml +++ b/.github/workflows/event-dispatcher.yml @@ -19,13 +19,13 @@ jobs: - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: - hugo-version: '0.86.1' + hugo-version: '0.108.0' extended: true - name: Setup Node uses: actions/setup-node@v1 with: - node-version: '12.x' + node-version: '16.x' - run: npm install diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 581b5559c..32bbe7ef0 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -18,13 +18,13 @@ jobs: - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: - hugo-version: '0.86.1' + hugo-version: '0.108.0' extended: true - name: Setup Node uses: actions/setup-node@v1 with: - node-version: '12.x' + node-version: '16.x' - run: npm install diff --git a/.gitignore b/.gitignore index b2342245f..856478c7a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ +/public +resources/ node_modules/ -public/ -/resources/ - -.DS_Store +package-lock.json .hugo_build.lock +_vendor diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index b76244d3b..000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "themes/docsy"] - path = themes/docsy - url = https://github.com/google/docsy.git diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..4e653452e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,4 @@ +FROM klakegg/hugo:ext-alpine + +RUN apk add git && \ + git config --global --add safe.directory /src diff --git a/README.md b/README.md index f18906f31..142b96024 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Drupal WxT -This Docsy derived project is hosted at [https://drupalwxt.github.io](https://drupalwxt.github.io). +This Docsy derived project is hosted at **[https://drupalwxt.github.io](https://drupalwxt.github.io)**. -> [Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. +> **[Docsy](https://github.com/google/docsy)** is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. diff --git a/assets/scss/_variables.scss b/assets/scss/_variables.scss deleted file mode 100644 index 7a3e660fd..000000000 --- a/assets/scss/_variables.scss +++ /dev/null @@ -1,137 +0,0 @@ -/* -Bootstrap variables overrides for theme. -See https://github.com/twbs/bootstrap/pull/23260 -*/ - -@fa-font-path : "../webfonts"; - -// Bootstrap flags. For more, see https://getbootstrap.com/docs/4.0/getting-started/theming/ - -$enable-gradients: true !default; -$enable-rounded: false !default; -$enable-shadows: true !default; - -// Theme flags - -$td-enable-google-fonts: true !default; - -// Drupal WxT colors - -$wxt-darker: rgb(38,55,74); -$wxt-lighter: rgb(77, 82, 85); - -// Theme colors - -$primary: #284162 !default; -$primary-light: lighten($primary, 75%) !default; -$secondary: $wxt-lighter; // #FFA630 !default; -$success: #3772FF !default; -$info: #6c757d !default; -$warning: #ED6A5A !default; -$danger: #ED6A5A !default; -$white: #fff !default; -$light: #f8f9fa !default; - -$dark: #070707 !default; -$blue: #72A1E5 !default; -$orange: #BA5A31 !default; -$gray-100: #f8f9fa !default; -$gray-200: #eee !default; -$gray-300: #dee2e6 !default; -$gray-400: #ccc !default; -$gray-500: #adb5bd !default; -$gray-600: #888 !default; -$gray-700: #495057 !default; -$gray-800: #333 !default; -$gray-900: #222 !default; -$black: #000 !default; - -$code-color: darken($secondary, 20%) !default; - -// UI element colors - -$border-color: $gray-300 !default; -$td-sidebar-tree-root-color: $primary !default; -$td-sidebar-bg-color: rgba($primary, 0.03) !default; -$td-sidebar-border-color: $border-color !default; - -// Background colors for the sections on home page etc. It is a paint by number system, starting at 0, where the number is taken from the shortcode's ordinal -// if not provided by the user. -// These colors are all part of the theme palette, but the mix is fairly random to create variation. This can be overridden by the project if needed. -$td-box-colors: $dark, $primary, $secondary, $info, $primary-light, $gray-600, $success, $warning, $dark, $danger, $primary, $secondary, $primary-light, $info !default; - -$link-color: darken($blue, 15%) !default; -$link-decoration: none !default; -$link-hover-color: darken($link-color, 15%) !default; -$link-hover-decoration: none !default; - -// Fonts - -$google_font_name: "Muli" !default; -$google_font_family: "Muli:300,300i,400,400i,700,700i" !default; -$web-font-path: "https://fonts.googleapis.com/css?family=#{$google_font_family}&display=swap"; - -$td-fonts-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; - -@if $td-enable-google-fonts { - $td-fonts-serif: prepend($td-fonts-serif, "#{$google_font_name}"); -} - -$font-family-sans-serif: $td-fonts-serif !default; - -$font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace !default; -$font-family-base: $font-family-sans-serif !default; -$font-size-base: 1rem !default; - -// Font weights - -$font-weight-light: 300 !default; -$font-weight-normal: 400 !default; -$font-weight-medium: 500 !default; -$font-weight-bold: 700 !default; - -$font-weight-body-text: $font-weight-normal !default; -$headings-font-weight: $font-weight-medium !default; - -// Heading sizes - -$h1-font-size: $font-size-base * 2.25 !default; -$h2-font-size: $font-size-base * 2 !default; -$h3-font-size: $font-size-base * 1.5 !default; -$h4-font-size: $font-size-base * 1.35 !default; -$h5-font-size: $font-size-base * 1.15 !default; -$h6-font-size: $font-size-base !default; - -// Display styles - -$display1-weight: $font-weight-bold !default; -$display2-weight: $font-weight-bold !default; -$display3-weight: $font-weight-bold !default; -$display4-weight: $font-weight-bold !default; -$display1-size: 3rem !default; -$display2-size: 2.5rem !default; -$display3-size: 2rem !default; -$display4-size: 1.75rem !default; - -// Space - -$spacer: 1rem; -$td-block-space-top-base: 4 * $spacer !default; -$td-block-space-bottom-base: 4 * $spacer !default; - -// Pagination - -$pagination-color: $gray-600 !default; -$pagination-border-color: rgba($black, 0.1) !default; -$pagination-active-border-color: darken($primary, 5%) !default; -$pagination-disabled-color: $gray-300 !default; - -// Navbar - -$navbar-dark-color: rgba($black, 0.75) !default; -$navbar-dark-hover-color: rgba($black, 0.5) !default; -$navbar-dark-active-color: $black !default; -$navbar-dark-disabled-color: rgba($black, 0.25) !default; - -// The yiq lightness value that determines when the lightness of color changes from "dark" to "light". -$yiq-contrasted-threshold: 200 !default; diff --git a/assets/scss/_variables_project.scss b/assets/scss/_variables_project.scss index a5e77fd4c..7bc7bbce2 100644 --- a/assets/scss/_variables_project.scss +++ b/assets/scss/_variables_project.scss @@ -1,3 +1,44 @@ +// Bootstrap flags. For more, see https://getbootstrap.com/docs/4.0/getting-started/theming/ + +$enable-gradients: true !default; +$enable-rounded: false !default; +$enable-shadows: true !default; + +// Drupal WxT colors + +$wxt-darker: rgb(38,55,74); +$wxt-lighter: rgb(77, 82, 85); + +// Theme colors + +$primary: #284162 !default; +$primary-light: lighten($primary, 75%) !default; +$secondary: $wxt-lighter; // #FFA630 !default; +$success: #3772FF !default; +$info: #6c757d !default; +$warning: #ED6A5A !default; +$danger: #ED6A5A !default; +$white: #fff !default; +$light: #f8f9fa !default; + +$dark: #070707 !default; +$blue: #72A1E5 !default; +$orange: #BA5A31 !default; +$gray-100: #f8f9fa !default; +$gray-200: #eee !default; +$gray-300: #dee2e6 !default; +$gray-400: #ccc !default; +$gray-500: #adb5bd !default; +$gray-600: #888 !default; +$gray-700: #495057 !default; +$gray-800: #333 !default; +$gray-900: #222 !default; +$black: #000 !default; + +$navbar-dark-color: rgba($black, 0.75) !default; +$navbar-dark-hover-color: rgba($black, 0.5) !default; +$navbar-dark-active-color: $black !default; +$navbar-dark-disabled-color: rgba($black, 0.25) !default; // Sidebar diff --git a/config/_default/config.toml b/config/_default/config.toml index 8b01c29df..375fd878c 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -1,6 +1,18 @@ baseURL = "/" title = "Drupal WxT" +# Language settings +contentDir = "content/en" +defaultContentLanguage = "en" +defaultContentLanguageInSubdir = true +# Useful when translating. +enableMissingTranslationPlaceholders = true +# Disable French until we make placeholder pages. +# When re-enabling, uncomment the language switcher in layouts/partials/navbar.html. +# disableLanguages = ["fr"] +refLinksErrorLevel = "WARNING" +refLinksNotFoundURL = "/" + enableRobotsTXT = true configDir = "config" @@ -18,26 +30,28 @@ relativeURLs = "true" # (the README.md files are kept for GitHub repo users so a landing pages appears) ignoreFiles = [ "README.md$" ] -# Hugo allows theme composition (and inheritance). The precedence is from left to right. -theme = ["docsy"] - # Will give values to .Lastmod etc. enableGitInfo = true -# Language settings -contentDir = "content/en" -defaultContentLanguage = "en" -defaultContentLanguageInSubdir = true -# Useful when translating. -enableMissingTranslationPlaceholders = true -# Disable French until we make placeholder pages. -# When re-enabling, uncomment the language switcher in layouts/partials/navbar.html. -# disableLanguages = ["fr"] -refLinksErrorLevel = "WARNING" -refLinksNotFoundURL = "/" - +# Comment out to enable taxonomies in Docsy # disableKinds = ["taxonomy", "taxonomyTerm"] +# You can add your own taxonomies +[taxonomies] +tag = "tags" +category = "categories" + +[params.taxonomy] +# set taxonomyCloud = [] to hide taxonomy clouds +taxonomyCloud = ["tags", "categories"] + +# If used, must have same length as taxonomyCloud +taxonomyCloudTitle = ["Tag Cloud", "Categories"] + +# set taxonomyPageHeader = [] to hide taxonomies on the page headers +taxonomyPageHeader = ["tags", "categories"] + + # Highlighting config pygmentsCodeFences = true pygmentsUseClasses = false @@ -47,19 +61,11 @@ pygmentsUseClassic = false # See https://help.farbox.com/pygments.html pygmentsStyle = "tango" - # First one is picked as the Twitter card image if not set on page. - #images = ["images/project-illustration.png"] - # Configure how URLs look like per section. [permalinks] blog = "/:section/:year/:month/:day/:slug/" releases = "/:section/:year/:month/:day/:slug/" -[outputs] -home = [ "HTML" ] -page = [ "HTML" ] -section = [ "HTML", "RSS", "print"] - ## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday [blackfriday] plainIDAnchors = true @@ -151,10 +157,19 @@ time_format_releases = "2006-01-02" # Everything below this are Site Params +# Comment out if you don't want the "print entire section" link enabled. +[outputs] +home = [ "HTML" ] +page = [ "HTML" ] +section = ["HTML", "print", "RSS"] + [params] copyright = "Drupal WxT" # privacy_policy = "https://policies.google.com/privacy" +# First one is picked as the Twitter card image if not set on page. +# images = ["images/project-illustration.png"] + # Menu title if your navbar has a versions selector to access old versions of your site. # This menu appears only if you have at least one [params.versions] set. version_menu = "Releases" @@ -181,22 +196,17 @@ github_repo = "https://github.com/drupalwxt/drupalwxt.github.io" # Specify a value here if your content directory is not in your repo's root directory # github_subdir = "userguide" -# Uncomment this if you have a newer GitHub repo with "main" as the default branch, +# Uncomment this if your GitHub repo does not have "main" as the default branch, # or specify a new value if you want to reference another branch in your GitHub links github_branch= "main" -time_format_blog = "Monday, January 02, 2006" -time_format_default = "January 2, 2006" -# Sections to publish in the main RSS feed. -rss_sections = ["blog"] - # Google Custom Search Engine ID. Remove or comment out to disable search. -# gcs_engine_id = "011217106833237091527:la2vtv2emlw" +# gcs_engine_id = "" # Enable Algolia DocSearch algolia_docsearch = false -# Enable offline search with Lunr.js +# Enable Lunr.js offline search offlineSearch = true offlineSearchSummaryLength = 175 offlineSearchMaxResults = 10 @@ -206,16 +216,18 @@ prism_syntax_highlighting = false # User interface configuration [params.ui] -# Enable to show the side bar menu in its compact state. -sidebar_menu_compact = true -sidebar_menu_foldable = false -sidebar_cache_limit = 10 # Set to true to disable breadcrumb navigation. breadcrumb_disable = false -# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) -sidebar_search_disable = false -# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar +# Set to true to disable the About link in the site footer +footer_about_disable = false +# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar navbar_logo = true +# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. +navbar_translucent_over_cover_disable = false +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = true +# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) +sidebar_search_disable = false # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. @@ -224,7 +236,6 @@ navbar_logo = true [params.ui.feedback] enable = true # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). -# Update with your own repository and response text. yes = 'Glad to hear it! Please tell us how we can improve.' no = 'Sorry to hear that. Please tell us how we can improve.' @@ -262,30 +273,20 @@ enable = false enable = true theme = "default" -[params.plantuml] -enable = true -theme = "default" -svg_image_url = "https://www.plantuml.com/plantuml/svg/" - -[params.katex] -enable = true -html_dom_element = "document.body" - -# enable display of chemical equations and physical units via mhchem extension -[params.katex.mhchem] -enable = true - [params.print] disable_toc = false -[params.markmap] -enable = true - -[params.taxonomy] -taxonomyCloud = ["tags", "categories"] # set taxonomyCloud = [] to hide taxonomy clouds -taxonomyCloudTitle = ["Tag Cloud", "Cloud of Categories"] # if used, must have same lang as taxonomyCloud -taxonomyPageHeader = ["tags", "categories"] # set taxonomyPageHeader = [] to hide taxonomies on the page headers - -[taxonomies] -tag = "tags" -category = "categories" +# hugo module configuration + +[module] + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + [module.hugoVersion] + extended = true + min = "0.75.0" + [[module.imports]] + path = "github.com/google/docsy" + disable = false + [[module.imports]] + path = "github.com/google/docsy/dependencies" + disable = false diff --git a/dev.sh b/dev.sh index d5eec5730..a8c53137d 100755 --- a/dev.sh +++ b/dev.sh @@ -2,8 +2,5 @@ echo -e "\033[0;32mStarting Hugo...\033[0m" -LOCALREPO=docsy - -hugo server --theme=$LOCALREPO \ - --environment local \ +hugo server --environment local \ --watch diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 000000000..2d1f5a161 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,13 @@ +version: "3.3" + +services: + + site: + image: drupalwxt/drupalwxt.github.io + build: + context: . + command: server + ports: + - "1313:1313" + volumes: + - .:/src diff --git a/go.mod b/go.mod new file mode 100644 index 000000000..0cca6c10d --- /dev/null +++ b/go.mod @@ -0,0 +1,10 @@ +module github.com/drupalwxt/drupalwxt.github.io + +go 1.17 + +require ( + github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f // indirect + github.com/google/docsy v0.6.0 // indirect + github.com/google/docsy/dependencies v0.6.0 // indirect + github.com/twbs/bootstrap v4.6.2+incompatible // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 000000000..61ae1abdc --- /dev/null +++ b/go.sum @@ -0,0 +1,8 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g= +github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= +github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= +github.com/google/docsy/dependencies v0.6.0 h1:BFXDCINbp8ZuUGl/mrHjMfhCg+b1YX+hVLAA5fGW7Pc= +github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o= +github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/package.json b/package.json index 103d7966c..5c65b6b1b 100644 --- a/package.json +++ b/package.json @@ -1,16 +1,16 @@ { "name": "drupalwxt-user-guide", - "version": "0.1.0", + "version": "0.2.0", "description": "This user guide is for project teams who are using the Drupal WxT distribution.", "main": "index.js", "devDependencies": { - "autoprefixer": "^9.8.8", - "js-yaml": ">=3.13.1", + "autoprefixer": "^10.4.13", + "js-yaml": ">=4.1.0", "lodash": "^4.17.21", - "mixin-deep": ">=1.3.2", - "postcss": "^8.3.9", - "postcss-cli": "^8.3.1", - "set-value": ">=2.0.1" + "mixin-deep": ">=2.0.1", + "postcss": "^8.4.21", + "postcss-cli": "^10.1.0", + "set-value": ">=4.1.0" }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" @@ -26,6 +26,6 @@ }, "homepage": "https://drupalwxt.github.io", "engines": { - "node": ">12.0" + "node": ">16.0" } } diff --git a/themes/docsy b/themes/docsy deleted file mode 160000 index 57d823b44..000000000 --- a/themes/docsy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 57d823b4450d730e29833ab8e6321b2783911c70