diff --git a/.prettierignore b/.prettierignore index caa71708..07f8f9b1 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,7 +1,7 @@ package.json package-lock.json _site -assets/css/jekyll-inpsyde-theme.scss +assets/css/jekyll-syde-theme.scss assets/js/vendor/lunr.min.js assets/js/search-data.json -assets/js/jekyll-inpsyde-theme.js +assets/js/jekyll-syde-theme.js diff --git a/.stylelintrc.json b/.stylelintrc.json index 0a58166a..61c084fb 100644 --- a/.stylelintrc.json +++ b/.stylelintrc.json @@ -1,6 +1,6 @@ { "ignoreFiles": [ - "assets/css/jekyll-inpsyde-theme.scss", + "assets/css/jekyll-syde-theme.scss", "_sass/vendor/**/*.scss" ], "extends": ["stylelint-config-primer", "stylelint-config-prettier"], diff --git a/README.md b/README.md index 3a2db427..743cdbd7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@

-

Inpsyde Jekyll Theme

+

Syde Jekyll Theme

-![jekyll-inpsyde-theme](./docs/assets/images/jekyll-inpsyde-theme-screenshot.jpg) +![jekyll-syde-theme](./docs/assets/images/jekyll-theme-screenshot.jpg) ## Introduction -This Jekyll Theme is used to provide layouts and styles for the documentation of Inpsyde's open source solutions on GitHub Pages. +This Jekyll Theme is used to provide layouts and styles for the documentation of Syde's open source solutions on GitHub Pages. ## Documentation -For more imformation, please refer to the [/docs](./docs) or go to https://inpsyde.github.io/jekyll-inpsyde-theme to see the theme in action _on its own documentation_. Very meta, we know. +For more information, please refer to the [/docs](./docs) or go to https://inpsyde.github.io/jekyll-syde-theme to see the theme in action _on its own documentation_. Very meta, we know. ## Credit diff --git a/_config.yml b/_config.yml index 1118bba4..20a8a9e0 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,5 @@ # This file is for local development. -# For generating inpsyde.github.io/jekyll-inpsyde-theme on GitHub Pages, use `docs/_config.yml`. +# For generating inpsyde.github.io/jekyll-syde-theme on GitHub Pages, use `docs/_config.yml`. # Note that on local development, both files will be merged. # This file overrides config in `docs/_config.yml`. diff --git a/_includes/cookie-consent.html b/_includes/cookie-consent.html index 11160f4e..55d4b37d 100644 --- a/_includes/cookie-consent.html +++ b/_includes/cookie-consent.html @@ -1,7 +1,7 @@ {% endif %} - + diff --git a/_layouts/default.html b/_layouts/default.html index 12bf3e29..dc5623a0 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -44,7 +44,7 @@
diff --git a/_sass/support/_variables.scss b/_sass/support/_variables.scss index 6c90e103..6c6fc8bb 100644 --- a/_sass/support/_variables.scss +++ b/_sass/support/_variables.scss @@ -60,7 +60,7 @@ $green-000: #41d693 !default; $green-100: #11b584 !default; $green-200: #009c7b !default; $green-300: #026e57 !default; -$green-inpsyde: #9fc65d !default; +$green-syde: #9fc65d !default; $yellow-000: #ffeb82 !default; $yellow-100: #fadf50 !default; @@ -84,7 +84,7 @@ $body-heading-color: $grey-dk-100 !default; $search-result-preview-color: $grey-dk-000 !default; $nav-child-link-color: $grey-dk-100 !default; $link-color: $body-text-color !default; -$btn-primary-color: $green-inpsyde !default; +$btn-primary-color: $green-syde !default; $base-button-color: #f7f7f7 !default; // diff --git a/_sass/typography.scss b/_sass/typography.scss index daccbe09..9921b503 100644 --- a/_sass/typography.scss +++ b/_sass/typography.scss @@ -7,7 +7,7 @@ h1, .text-alpha { font-size: $font-size-8; font-weight: 800; - color: $green-inpsyde; + color: $green-syde; } h2, diff --git a/assets/css/jekyll-inpsyde-theme.scss b/assets/css/jekyll-inpsyde-theme.scss deleted file mode 100644 index e3a0f9d4..00000000 --- a/assets/css/jekyll-inpsyde-theme.scss +++ /dev/null @@ -1,3 +0,0 @@ ---- ---- -{% include css/jekyll-inpsyde-theme.scss.liquid %} diff --git a/assets/css/jekyll-syde-theme.scss b/assets/css/jekyll-syde-theme.scss new file mode 100644 index 00000000..60ef813e --- /dev/null +++ b/assets/css/jekyll-syde-theme.scss @@ -0,0 +1,3 @@ +--- +--- +{% include css/jekyll-syde-theme.scss.liquid %} diff --git a/assets/images/jekyll-inpsyde-theme.svg b/assets/images/jekyll-inpsyde-theme.svg deleted file mode 100644 index b0a42189..00000000 --- a/assets/images/jekyll-inpsyde-theme.svg +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/assets/images/jekyll-theme.svg b/assets/images/jekyll-theme.svg new file mode 100644 index 00000000..0020f56d --- /dev/null +++ b/assets/images/jekyll-theme.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/README.md b/docs/README.md index f8fd13b5..6c1ae8b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,9 +4,9 @@ nav_order: 0 permalink: / --- -# Inpsyde Jekyll Theme +# Syde Jekyll Theme -![jekyll-inpsyde-theme](./assets/images/jekyll-inpsyde-theme-screenshot.jpg) +![jekyll-syde-theme](./assets/images/jekyll-theme-screenshot.jpg) ## Credit This Jekyll Theme is a fork of the original from Just the docs diff --git a/docs/_config.yml b/docs/_config.yml index 6f813414..763dce29 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,17 +1,17 @@ -# This file is for generating inpsyde.github.io/jekyll-inpsyde-theme on GitHub Pages. +# This file is for generating inpsyde.github.io/jekyll-syde-theme on GitHub Pages. # For local development, use `_config.yml` at repo root. -title: Inpsyde Jekyll Theme -description: A Jekyll theme for Inpsyde package/plugin documentation -baseurl: /jekyll-inpsyde-theme # Your repo name with a leading slash. +title: Syde Jekyll Theme +description: A Jekyll theme for Syde package/plugin documentation +baseurl: /jekyll-syde-theme # Your repo name with a leading slash. # Aux links for the upper right navigation aux_links: - "Inpsyde Jekyll Theme on GitHub": - - https://github.com/inpsyde/jekyll-inpsyde-theme + "Syde Jekyll Theme on GitHub": + - https://github.com/inpsyde/jekyll-syde-theme # Footer "Edit this page on GitHub" link text -gh_edit_repository: https://github.com/inpsyde/jekyll-inpsyde-theme # Your repo GitHub URL +gh_edit_repository: https://github.com/inpsyde/jekyll-syde-theme # Your repo GitHub URL # Everything above is repo specific. @@ -23,18 +23,18 @@ gh_edit_branch: master # The default branch of the repo. Default: main gh_edit_source: docs # The directory containing the docs. Default: docs exclude: - - "tests/" # This is jekyll-inpsyde-theme specific! + - "tests/" # This is jekyll-syde-theme specific! ############################################################### # Everything below should be copy and pasted into package repos -remote_theme: inpsyde/jekyll-inpsyde-theme +remote_theme: inpsyde/jekyll-syde-theme ############################################################### # Everything below should be copy and pasted into package repos -# To be replaced by jekyll-inpsyde-theme's `_config.yml` when GitHub Pages supports Jekyll v4. +# To be replaced by jekyll-syde-theme's `_config.yml` when GitHub Pages supports Jekyll v4. plugins: - jekyll-remote-theme diff --git a/docs/assets/images/jekyll-inpsyde-theme-screenshot.jpg b/docs/assets/images/jekyll-syde-theme-screenshot.jpg similarity index 100% rename from docs/assets/images/jekyll-inpsyde-theme-screenshot.jpg rename to docs/assets/images/jekyll-syde-theme-screenshot.jpg diff --git a/docs/setup.md b/docs/setup.md index 6a0751e1..d1d16bd8 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -74,12 +74,12 @@ gh_edit_source: docs # The directory containing the docs. Default: docs # Everything below should be copy and pasted into package repos -remote_theme: inpsyde/jekyll-inpsyde-theme +remote_theme: inpsyde/jekyll-syde-theme ############################################################### # Everything below should be copy and pasted into package repos -# To be replaced by jekyll-inpsyde-theme's `_config.yml` when GitHub Pages supports Jekyll v4. +# To be replaced by jekyll-syde-theme's `_config.yml` when GitHub Pages supports Jekyll v4. plugins: - jekyll-remote-theme @@ -115,10 +115,6 @@ The best way to use this package is: composer require inpsyde/ ``` -## Crafted by Inpsyde - -The team at [Inpsyde](https://inpsyde.com) is engineering the Web since 2006. - ## License Copyright (c) 2021, Inpsyde GmbH @@ -211,7 +207,7 @@ The Jekyll site will be avaible at `https://inpsyde.github.io/` - The person who pushed the changes must have their email addresses verified on GitHub. For more information, see [Verifying your email address](https://docs.github.com/en/get-started/signing-up-for-github/verifying-your-email-address) - If GitHub reports any Jekyll build error messages, [build your site locally](#serve-the-jekyll-site-locally) to see any misconfiguration -- Ask on the `#p-jekyll-inpsyde-theme` Slack channel if you need further help +- Ask on the `#p-jekyll-syde-theme` Slack channel if you need further help #### Purging GitHub Pages Cache diff --git a/docs/theme-development.md b/docs/theme-development.md index 0234ec2f..ac019a6a 100644 --- a/docs/theme-development.md +++ b/docs/theme-development.md @@ -12,7 +12,7 @@ nav_order: 2 ## Clone the Git Repository ```bash -git clone https://github.com/inpsyde/jekyll-inpsyde-theme +git clone https://github.com/inpsyde/jekyll-syde-theme ``` ## Serve the Jekyll Site Locally @@ -36,7 +36,7 @@ docker run --rm -it \ jekyll serve -c docs/_config.yml,_config.yml ``` -Open your browser at `http://localhost:4000/jekyll-inpsyde-theme/`. +Open your browser at `http://localhost:4000/jekyll-syde-theme/`. ### Ruby @@ -52,13 +52,13 @@ bundle add --group=jekyll_plugins --version='>= 0' github-pages bundle exec jekyll serve -c docs/_config.yml,_config.yml ``` -Open your browser at `http://localhost:4000/jekyll-inpsyde-theme/`. +Open your browser at `http://localhost:4000/jekyll-syde-theme/`. ## Test Content -Test content at [`docs/tests`](https://github.com/inpsyde/jekyll-inpsyde-theme/tree/master/docs/tests) are excluded by default. If you wish to use them during development: +Test content at [`docs/tests`](https://github.com/inpsyde/jekyll-syde-theme/tree/master/docs/tests) are excluded by default. If you wish to use them during development: -First, comment out this line in [`_config.yml`](https://github.com/inpsyde/jekyll-inpsyde-theme/blob/master/_config.yml) at repo root: +First, comment out this line in [`_config.yml`](https://github.com/inpsyde/jekyll-syde-theme/blob/master/_config.yml) at repo root: ```diff # _config.yml @@ -71,17 +71,17 @@ First, comment out this line in [`_config.yml`](https://github.com/inpsyde/jekyl Then, restart the Jekyll server. -Test content is avaible at [http://localhost:4000/jekyll-inpsyde-theme/tests/]({{ site.baseurl }}/tests/) +Test content is avaible at [http://localhost:4000/jekyll-syde-theme/tests/]({{ site.baseurl }}/tests/) ## `_config.yml` vs `docs/_config.yml` -[`docs/_config.yml`](https://github.com/inpsyde/jekyll-inpsyde-theme/blob/master/docs/_config.yml) is for generating https://inpsyde.github.io/jekyll-inpsyde-theme on GitHub Pages. +[`docs/_config.yml`](https://github.com/inpsyde/jekyll-syde-theme/blob/master/docs/_config.yml) is for generating https://inpsyde.github.io/jekyll-inpsyde-theme on GitHub Pages. -[`_config.yml`](https://github.com/inpsyde/jekyll-inpsyde-theme/blob/master/_config.yml) at repo root is for generating http://localhost:4000/jekyll-inpsyde-theme/docs for local development. +[`_config.yml`](https://github.com/inpsyde/jekyll-syde-theme/blob/master/_config.yml) at repo root is for generating http://localhost:4000/jekyll-inpsyde-theme/docs for local development. -Whenever duplicated, [`_config.yml`](https://github.com/inpsyde/jekyll-inpsyde-theme/blob/master/_config.yml) at repo root takes priority. +Whenever duplicated, [`_config.yml`](https://github.com/inpsyde/jekyll-syde-theme/blob/master/_config.yml) at repo root takes priority. -Similarly, the local site might contains `/docs/` in the URLs. This is because Jekyll translates the file paths into permalinks. The `/docs/` part will be stripped away on `https://inpsyde.github.io/jekyll-inpsyde-theme`. +Similarly, the local site might contains `/docs/` in the URLs. This is because Jekyll translates the file paths into permalinks. The `/docs/` part will be stripped away on `https://inpsyde.github.io/jekyll-syde-theme`. ## Tips diff --git a/package.json b/package.json index 1e182fa7..0ca6e342 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { - "name": "jekyll-inpsyde-theme", + "name": "jekyll-syde-theme", "version": "0.0.1", - "description": "A modern Jekyll theme for Inpsyde documentation", - "repository": "inpsyde/jekyll-inpsyde-theme", + "description": "A modern Jekyll theme for Syde documentation", + "repository": "inpsyde/jekyll-syde-theme", "license": "MIT", - "bugs": "https://github.com/inpsyde/jekyll-inpsyde-theme/issues", + "bugs": "https://github.com/inpsyde/jekyll-syde-theme/issues", "devDependencies": { "stylelint": "^13.7.2", "@primer/css": "^15.2.0",