Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update for migration from Hyas to Thulite #1276

Merged
merged 2 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": ["@changesets/changelog-github", { "repo": "gethyas/doks" }],
"changelog": ["@changesets/changelog-github", { "repo": "thuliteio/doks" }],
"commit": false,
"fixed": [],
"linked": [],
Expand Down
5 changes: 5 additions & 0 deletions .changeset/perfect-emus-fly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"doks": minor
---

Update for migration from Hyas to Thulite
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contact_links:
- name: 📘 Documentation
url: https://github.com/gethyas/getdoks.org
url: https://github.com/thuliteio/getdoks.org
about: File an issue or make an improvement to the Doks website.
- name: 💁 Support
url: https://github.com/gethyas/doks/discussions
url: https://github.com/thuliteio/doks/discussions
about: 'Get help on Doks Discussions'
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Why are we doing this? What use cases does it support? What is the expected outc

## Checks

- [ ] Read [Create a Pull Request](https://gethyas.com/docs/contributing/how-to-contribute/#create-a-pull-request)
- [ ] Read [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
- [ ] Supports all screen sizes (if relevant)
- [ ] Supports both light and dark mode (if relevant)
- [ ] Passes `npm run test`
- [ ] Passes `npm run test` (if relevant)
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020-2024 Hyas
Copyright (c) 2020-2024 Thulite

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Doks

Doks is a documentation theme for [Hyas](https://gethyas.com/).
Doks is a documentation theme for [Thulite](https://thulite.io/).

## Demo

Expand All @@ -11,7 +11,7 @@ Doks is a documentation theme for [Hyas](https://gethyas.com/).
The recommended way to install the latest version of Doks is by running the command below:

```bash
npm create hyas@latest -- --template doks
npm create thulite@latest -- --template doks
```

Looking for help? Start with our [Getting Started](https://getdoks.org/docs/start-here/getting-started/) guide.
Expand All @@ -22,7 +22,7 @@ Visit our [official documentation](https://getdoks.org/).

## Support

Having trouble? Get help in the official [Doks Discussions](https://github.com/h-enk/doks/discussions).
Having trouble? Get help in the official [Doks Discussions](https://github.com/thuliteio/doks/discussions).

## Contributing

Expand All @@ -31,10 +31,10 @@ New contributors welcome! Check out our [Contributor Guides](https://getdoks.org
## Links

- [License (MIT)](LICENSE)
- [Code of Conduct](https://github.com/gethyas/.github/blob/main/CODE_OF_CONDUCT.md)
- [Code of Conduct](https://github.com/thuliteio/.github/blob/main/CODE_OF_CONDUCT.md)
- [Project Funding](.github/FUNDING.md)
- [Website](https://getdoks.org/)

## Sponsors

Doks is supported by Netlify, Algolia, and several other amazing organizations and inidviduals. [Sponsor Doks!](.github/FUNDING.md) ❤️
Doks is free, open source software made possible by by Netlify, Algolia, and several other amazing organizations and inidviduals. [Sponsor Doks](.github/FUNDING.md) ❤️
2 changes: 1 addition & 1 deletion assets/jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"compilerOptions": {
"baseUrl": ".",
"paths": {
"*": ["*", "..\\node_modules\\@hyas\\doks-core\\assets\\*"]
"*": ["*", "..\\node_modules\\@thulite\\doks-core\\assets\\*"]
}
}
}
2 changes: 1 addition & 1 deletion config/_default/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ defaultContentLanguage = "en"
disableLanguages = ["de", "nl"]
defaultContentLanguageInSubdir = false

copyRight = "Copyright (c) 2020-2024 Hyas"
copyRight = "Copyright (c) 2020-2024 Thulite"

[build.buildStats]
enable = true
Expand Down
4 changes: 2 additions & 2 deletions config/_default/languages.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[en.params]
languageISO = "EN"
languageTag = "en-US"
footer = 'Brought to you by <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
footer = 'Brought to you by <a class="text-muted" href="https://thulite.io/">Thulite</a>'
alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'

[de]
Expand All @@ -15,7 +15,7 @@
[de.params]
languageISO = "DE"
languageTag = "de-DE"
footer = 'Gebaut mit <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
footer = 'Gebaut mit <a class="text-muted" href="https://thulite.io/">Thulite</a>'
alertText = 'Neue Version ist da! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.5/">Doks v0.5</a>'

[nl]
Expand Down
8 changes: 4 additions & 4 deletions config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-x" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M4 4l11.733 16h4.267l-11.733 -16z"></path><path d="M4 20l6.768 -6.768m2.46 -2.46l6.772 -6.772"></path></svg>'
# url = "https://twitter.com/getdoks"
# weight = 10
#
#
# [[social]]
# name = "Discord"
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-discord" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M8 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M14 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M8.5 17c0 1 -1.356 3 -1.832 3c-1.429 0 -2.698 -1.667 -3.333 -3c-.635 -1.667 -.476 -5.833 1.428 -11.5c1.388 -1.015 2.782 -1.34 4.237 -1.5l.975 1.923a11.913 11.913 0 0 1 4.053 0l.972 -1.923c1.5 .16 3.043 .485 4.5 1.5c2 5.667 2.167 9.833 1.5 11.5c-.667 1.333 -2 3 -3.5 3c-.5 0 -2 -2 -2 -3"></path><path d="M7 16.5c3.5 1 6.5 1 10 0"></path></svg>'
Expand All @@ -54,7 +54,7 @@
[[social]]
name = "GitHub"
pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
url = "https://github.com/gethyas/doks"
url = "https://github.com/thuliteio/doks"
post = "v0.1.0"
weight = 30

Expand All @@ -68,12 +68,12 @@
# name = "Guides"
# pageRef = "/docs/guides"
# weight = 10
#
#
# [[sidebar_docs]]
# name = "Reference"
# pageRef = "/docs/reference"
# weight = 20
#
#
# [[sidebar_docs]]
# name = "Resources"
# pageRef = "/docs/resources"
Expand Down
24 changes: 12 additions & 12 deletions config/_default/module.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# mounts
## archetypes
[[mounts]]
source = "node_modules/@hyas/doks-core/archetypes"
source = "node_modules/@thulite/doks-core/archetypes"
target = "archetypes"

[[mounts]]
Expand All @@ -10,15 +10,15 @@

## assets
[[mounts]]
source = "node_modules/@hyas/core/assets"
source = "node_modules/@thulite/core/assets"
target = "assets"

[[mounts]]
source = "node_modules/@hyas/images/assets"
source = "node_modules/@thulite/images/assets"
target = "assets"

[[mounts]]
source = "node_modules/@hyas/doks-core/assets"
source = "node_modules/@thulite/doks-core/assets"
target = "assets"

[[mounts]]
Expand All @@ -36,7 +36,7 @@

## data
[[mounts]]
source = "node_modules/@hyas/doks-core/data"
source = "node_modules/@thulite/doks-core/data"
target = "data"

[[mounts]]
Expand All @@ -45,7 +45,7 @@

## i18n
[[mounts]]
source = "node_modules/@hyas/doks-core/i18n"
source = "node_modules/@thulite/doks-core/i18n"
target = "i18n"

[[mounts]]
Expand All @@ -54,23 +54,23 @@

## layouts
[[mounts]]
source = "node_modules/@hyas/core/layouts"
source = "node_modules/@thulite/core/layouts"
target = "layouts"

[[mounts]]
source = "node_modules/@hyas/seo/layouts"
source = "node_modules/@thulite/seo/layouts"
target = "layouts"

[[mounts]]
source = "node_modules/@hyas/images/layouts"
source = "node_modules/@thulite/images/layouts"
target = "layouts"

[[mounts]]
source = "node_modules/@hyas/doks-core/layouts"
source = "node_modules/@thulite/doks-core/layouts"
target = "layouts"

[[mounts]]
source = "node_modules/@hyas/inline-svg/layouts"
source = "node_modules/@thulite/inline-svg/layouts"
target = "layouts"

[[mounts]]
Expand All @@ -79,7 +79,7 @@

## static
[[mounts]]
source = "node_modules/@hyas/doks-core/static"
source = "node_modules/@thulite/doks-core/static"
target = "static"

[[mounts]]
Expand Down
18 changes: 9 additions & 9 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ mainSections = ["docs"]
[social]
twitter = "getdoks"

# Doks (@hyas/doks-core)
# Doks (@thulite/doks-core)
[doks]
# Color mode
colorMode = "auto" # auto (default), light or dark
Expand Down Expand Up @@ -102,22 +102,22 @@ mainSections = ["docs"]
errorLevel = 'ignore' # ignore (default), warning, or error (fails the build)
highlightBroken = false # true or false (default)

# Images (@hyas/images)
[hyas_images]
[hyas_images.defaults]
# Images (@thulite/images)
[thulite_images]
[thulite_images.defaults]
decoding = "async" # sync, async, or auto (default)
fetchpriority = "auto" # high, low, or auto (default)
fetchpriority = "auto" # high, low, or auto (default)
loading = "lazy" # eager or lazy (default)
widths = [480, 576, 768, 1025, 1200, 1440] # [640, 768, 1024, 1366, 1600, 1920] for example
sizes = "auto" # 100vw (default), 75vw, or auto for example
process = "" # "fill 1600x900" or "fill 2100x900" for example
lqip = "16x webp q20" # "16x webp q20" or "21x webp q20" for example

# Inline SVG (@hyas/inline-svg)
# Inline SVG (@thulite/inline-svg)
[inline_svg]
iconSetDir = "tabler-icons" # "tabler-icons" (default)

# SEO (@hyas/seo)
# SEO (@thulite/seo)
[seo]
[seo.title]
separator = " | "
Expand All @@ -131,8 +131,8 @@ mainSections = ["docs"]
[seo.schemas]
type = "Organization" # Organization (default) or Person
logo = "favicon-512x512.png" # Logo of Organization — favicon-512x512.png (default)
name = "Hyas" # Name of Organization or Person
sameAs = [] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"]
name = "Thulite" # Name of Organization or Person
sameAs = [] # E.g. ["https://github.com/thuliteio/thulite", "https://fosstodon.org/@thulite"]
images = ["cover.png"] # ["cover.png"] (default)
article = [] # Article sections
newsArticle = [] # NewsArticle sections
Expand Down
3 changes: 2 additions & 1 deletion config/postcss.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ module.exports = {
'hiding',
'page-item',
'page-link',
...whitelister(['./assets/scss/**/*.scss', './node_modules/@hyas/doks-core/assets/scss/components/_code.scss', './node_modules/@hyas/doks-core/assets/scss/components/_expressive-code.scss', './node_modules/@hyas/doks-core/assets/scss/common/_syntax.scss'])
'not-content',
...whitelister(['./assets/scss/**/*.scss', './node_modules/@thulite/doks-core/assets/scss/components/_code.scss', './node_modules/@thulite/doks-core/assets/scss/components/_expressive-code.scss', './node_modules/@thulite/doks-core/assets/scss/common/_syntax.scss'])
]
})
]
Expand Down
2 changes: 1 addition & 1 deletion layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h2 class="h4">Add new content</h2>
</div>
<div class="col-lg-5">
<h2 class="h4">Configure your site</h2>
<p>Edit your config in <code>config/_default/hyas/doks.toml</code>.</p>
<p>Edit your config in <code>config/_default/params.toml</code>.</p>
</div>
<div class="col-lg-5">
<h2 class="h4">Read the docs</h2>
Expand Down
Loading