Skip to content

Commit

Permalink
👷 fix docs URL
Browse files Browse the repository at this point in the history
  • Loading branch information
dennisreimann committed Nov 4, 2024
1 parent 41b496a commit 96107bb
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
1 change: 0 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,5 @@ jobs:
with:
publish_dir: ./docs/dist
github_token: ${{ secrets.GITHUB_TOKEN }}
cname: uiengine.uix.space
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ For details see the
### Added

- Set browser-sync `startPath` for custom UI base
- New [documentation site](https://uiengine.uix.space/), generated with the UIengine itself
- New [documentation site](https://dennisreimann.github.io/uiengine/), generated with the UIengine itself

### Changed

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ npx uiengine init --demo
npx uiengine build --serve --watch
```

See the [getting started guide](https://uiengine.uix.space/basics/getting-started/)
See the [getting started guide](https://dennisreimann.github.io/uiengine/basics/getting-started/)
for further details.
There are also some [introduction videos](https://www.youtube.com/watch?v=YBm_ye9da-Q&list=PLBXz0hPvV2jNAFb9KxvV-2Op8cy3tA8E2):

Expand All @@ -40,13 +40,13 @@ There are also some [introduction videos](https://www.youtube.com/watch?v=YBm_ye

To get an idea of what a real-world project looks like, see the React sample project:

- [Tasty BBQ Design System](https://uiengine-sample-react.uix.space/design-system/): The UIengine output for this sample project
- [Tasty BBQ Website](https://uiengine-sample-react.uix.space/): The corresponding website, built with React and Next.js.
- [Tasty BBQ Design System](https://dennisreimann.github.io/uiengine-sample-react/design-system/): The UIengine output for this sample project
- [Tasty BBQ Website](https://dennisreimann.github.io/uiengine-sample-react/): The corresponding website, built with React and Next.js.
- [Tasty BBQ Source Code](https://github.com/dennisreimann/uiengine-sample-react).

## 📘 Documentation

See the [documentation](https://uiengine.uix.space/) site, which is also generated with the UIengine.
See the [documentation](https://dennisreimann.github.io/uiengine/) site, which is also generated with the UIengine.

## 🔩 Technical TL;DR

Expand Down Expand Up @@ -117,7 +117,7 @@ Here are some other projects that you might want to evaluate:
## 🛠 Development

You like this project and are interested in participating?
See the [development docs](https://uiengine.uix.space/development/contributing/) for an introduction and workflows when hacking on the UIengine.
See the [development docs](https://dennisreimann.github.io/uiengine/development/contributing/) for an introduction and workflows when hacking on the UIengine.

## ✨ Contributors

Expand Down
2 changes: 1 addition & 1 deletion docs/adapter/css.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ src

See the [test project](https://github.com/dennisreimann/uiengine/tree/master/test/project/src) for an example of the file contents.

For an example of the output have a look at the "Themes" tab of the [label component sample](https://uiengine.uix.space/test-project/patterns/atoms/label/).
For an example of the output have a look at the "Themes" tab of the [label component sample](https://dennisreimann.github.io/uiengine/test-project/patterns/atoms/label/).
11 changes: 6 additions & 5 deletions docs/uiengine.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const meta = (name, content) => ({

module.exports = {
name: 'UIengine Documentation',
logo: '/images/logo.svg',
logo: '/uiengine/images/logo.svg',
version: pkg.version,

source: {
Expand All @@ -26,6 +26,7 @@ module.exports = {
target: 'dist',

ui: {
base: '/uiengine/',
customStylesFile: '/styles/docs.css',
meta: [
meta('description', 'The UIengine is a workbench for UI-driven development: A tool for developers and designers to build and document web sites and apps.'),
Expand Down Expand Up @@ -53,14 +54,14 @@ module.exports = {

meta('og:type', 'website'),
meta('og:title', 'UIengine'),
meta('og:url', 'https://uiengine.uix.space/'),
meta('og:url', 'https://dennisreimann.github.io/uiengine/'),
meta('og:site_name', 'UIengine Documentation'),
meta('og:description', 'The UIengine is a workbench for UI-driven development: A tool for developers and designers to build and document web sites and apps.'),
meta('og:image:width', 1024),
meta('og:image:height', 640),
meta('og:image', 'http://uiengine.uix.space/card.png'),
meta('og:image:secure_url', 'https://uiengine.uix.space/card.png'),
meta('twitter:image', 'https://uiengine.uix.space/card.png'),
meta('og:image', 'http://dennisreimann.github.io/uiengine/card.png'),
meta('og:image:secure_url', 'https://dennisreimann.github.io/uiengine/card.png'),
meta('twitter:image', 'https://dennisreimann.github.io/uiengine/card.png'),
meta('twitter:card', 'summary_large_image'),
meta('twitter:site', '@dennisreimann')
],
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/demo/pages/documentation/tokens/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Design Tokens

See the [UIengine design token documentation](https://uiengine.uix.space/advanced/design-tokens/) for details.
See the [UIengine design token documentation](https://dennisreimann.github.io/uiengine/advanced/design-tokens/) for details.
2 changes: 1 addition & 1 deletion packages/cli/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ module.exports = require('yargs')
.alias('h', 'help')
.version()
.alias('v', 'version')
.epilogue('Documentation: https://uiengine.uix.space/')
.epilogue('Documentation: https://dennisreimann.github.io/uiengine/')
.argv
2 changes: 1 addition & 1 deletion packages/cli/src/templates/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module.exports = {
// Project config: Defaults to name and version from package.json.
// Here you can overwrite it and add more custom properties.
// For a detailed documentation of all the options in here see
// https://uiengine.uix.space/basics/config/
// https://dennisreimann.github.io/uiengine/basics/config/
name: '${values.name}',
// Base directories for the input, your raw source files:
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/templates/initial_page_readme.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ npx uiengine build --watch --serve
\`\`\`
Under the hood [BrowserSync](https://www.browsersync.io/) is used to provide serving and watching the files.
For information on how to configure the server and pass additional options, see the [configuration documentation](https://uiengine.uix.space/basics/config/#BrowserSync).`
For information on how to configure the server and pass additional options, see the [configuration documentation](https://dennisreimann.github.io/uiengine/basics/config/#BrowserSync).`

0 comments on commit 96107bb

Please sign in to comment.