Skip to content

Commit

Permalink
Merge pull request #566 from cocopon/fix-docs
Browse files Browse the repository at this point in the history
Fix documents
  • Loading branch information
cocopon authored Aug 6, 2023
2 parents 8005145 + d822799 commit 8f51679
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Tweakpane is a compact pane library for fine-tuning parameters and monitoring
value changes, inspired by [dat.GUI][].
(dat.GUI user? The [migration guide](https://cocopon.github.io/tweakpane/migration/#datgui) can be helpful)
(dat.GUI user? The [migration guide](https://tweakpane.github.io/docs/migration/#datgui) can be helpful)


## Concept
Expand All @@ -20,33 +20,33 @@ value changes, inspired by [dat.GUI][].
See the [official page][documents] for details.


### [Bindings](https://cocopon.github.io/tweakpane/input-bindings/)
### [Bindings](https://tweakpane.github.io/docs/input-bindings/)
Number, String, Boolean, Color, Point 2D/3D/4D

![Bindings](https://user-images.githubusercontent.com/602961/184479032-38f50be3-e235-4914-85c0-dce316b33ed2.png)


### [Readonly bindings](https://cocopon.github.io/tweakpane/monitor-bindings/)
### [Readonly bindings](https://tweakpane.github.io/docs/monitor-bindings/)
Number, String, Boolean

![Readonly bindings](https://user-images.githubusercontent.com/602961/184479060-44fda993-9f40-4ef1-b363-18e9f9deff7f.png)


### [UI components](https://cocopon.github.io/tweakpane/ui-components/)
### [UI components](https://tweakpane.github.io/docs/ui-components/)
Folder, Tab, Button, Separator

![UI components](https://user-images.githubusercontent.com/602961/184479079-84ee5436-b5f6-4c35-92eb-94cc8709ff12.png)


### [Theming](https://cocopon.github.io/tweakpane/theming/)
### [Theming](https://tweakpane.github.io/docs/theming/)
![Theming](https://user-images.githubusercontent.com/602961/115102105-e6676500-9f83-11eb-8a74-ae4f76122000.png)


### [Plugins](https://cocopon.github.io/tweakpane/plugins/)
### [Plugins](https://tweakpane.github.io/docs/plugins/)
![Plugins](https://user-images.githubusercontent.com/602961/184479086-cc8c72c2-c958-4e4e-8ae4-2690f721c544.png)


### [Misc](https://cocopon.github.io/tweakpane/misc/)
### [Misc](https://tweakpane.github.io/docs/misc/)
- Mobile support
- TypeScript type definitions
- JSON import / export
Expand Down Expand Up @@ -77,4 +77,4 @@ MIT License. See `LICENSE.txt` for more information.


[dat.GUI]: https://github.com/dataarts/dat.gui
[documents]: https://cocopon.github.io/tweakpane/
[documents]: https://tweakpane.github.io/docs/
2 changes: 1 addition & 1 deletion packages/tweakpane/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "A compact pane for fine-tuning parameters and monitoring value changes",
"author": "cocopon",
"license": "MIT",
"homepage": "https://cocopon.github.io/tweakpane/",
"homepage": "https://tweakpane.github.io/docs/",
"main": "dist/tweakpane.js",
"type": "module",
"types": "dist/types/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/tweakpane/src/doc/template/_template.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
{% endif %}
<meta name="viewport" content="initial-scale=1,minimum-scale=1,maximum-scale=1">
<meta name="og:description" content="{{ description }}">
<meta property="og:image" content="https://cocopon.github.io/tweakpane/assets/og.png">
<meta property="og:image" content="https://tweakpane.github.io/docs/assets/og.png">
<meta name="og:title" content="Tweakpane">
<meta property="og:type" content="website">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:description" content="{{ description }}">
<meta name="twitter:image" content="https://cocopon.github.io/tweakpane/assets/og.png">
<meta name="twitter:image" content="https://tweakpane.github.io/docs/assets/og.png">
<meta name="twitter:title" content="Tweakpane">
<link rel="stylesheet" href="{{ root }}assets/bundle.css">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div class="logoSwitcher">
<select class="logoSwitcher_select">
<option value="">{{ version }}</option>
<option value="{{ root }}../v3/">3.x</option>
<option value="{{ root }}/v3/">3.x</option>
</select>
<div class="logoSwitcher_arrow"></div>
</div>
Expand Down

0 comments on commit 8f51679

Please sign in to comment.