Skip to content

Commit

Permalink
update links and headers
Browse files Browse the repository at this point in the history
  • Loading branch information
hybridherbst committed Dec 20, 2024
1 parent d9dfdf4 commit 7f77d5b
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 16 deletions.
7 changes: 6 additions & 1 deletion documentation/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export default defineUserConfig({
themes: { light: 'catppuccin-latte', dark: 'catppuccin-frappe' },
lineNumbers: false,
highlightLines: false,
__disabled__transformers: [
transformers: [
// HACK to add the import statement to the code
/*
{
Expand Down Expand Up @@ -315,6 +315,7 @@ export default defineUserConfig({
"/blender/",
"/three/",
"/embedding",
"/cloud/",
// "/custom-integrations/",
]
},
Expand Down Expand Up @@ -497,6 +498,10 @@ export default defineUserConfig({
text: 'Custom integrations',
link: '/custom-integrations/',
},
{
text: 'Needle Cloud',
link: '/cloud/',
},
{
text: 'Support and Community',
link: '/support',
Expand Down
15 changes: 11 additions & 4 deletions documentation/blender/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@ title: Needle Engine for Blender
editLink: true
---
<br/>
<img src="/blender/logo.png" style="max-height:70px;" />
<div class="centered" style="display: flex;
align-items: center;
gap: 20px;
font-size: 2em;
font-weight: 100;">
<img src="/logo.png" style="max-height:70px;" title="Needle Logo" alt="Needle Logo"/> +
<img src="/blender/logo.png" style="max-height:70px;" />
</div>

# Needle Engine for Blender

Expand Down Expand Up @@ -50,7 +57,7 @@ You'll be able to sequence animations, easily lightmap your scenes, add interact

:::tip Providing Feedback

**Your feedback is invaluable** when it comes to deciding which features and workflows we should prioritize. If you have feedback for us (good or bad), please [let us know in the forum](https://forum.needle.tools)!
**Your feedback is invaluable** when it comes to deciding which features and workflows we should prioritize. If you have feedback for us (good or bad), please [let us know in the forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content)!
:::

## Samples for Blender
Expand Down Expand Up @@ -260,7 +267,7 @@ Alternatively you can also use the Lightmapping panel in the `Render Properties`
![Lightmapping object](/blender/lightmapping-panel.webp)

::: warning Experimental Feature
The lightmapping plugin is experimental. We recommend creating a backup of your .blend file when using it. Please report problems or errors you encounter in [our forum](https://forum.needle.tools) 🙏
The lightmapping plugin is experimental. We recommend creating a backup of your .blend file when using it. Please report problems or errors you encounter in [our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) 🙏
:::

## Texture Compression
Expand All @@ -279,7 +286,7 @@ Simply click the icon to download the new version.

## Reporting an issue

If you run into any problems we're more than happy to help! Please join [our discord](https://discord.needle.tools) for fast support.
If you run into any problems we're more than happy to help! Please join [our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) for fast support.

Please also check the logs in Blender. You can find logs specific to the Needle Engine Addon via `Help/Needle` in Blender.

Expand Down
10 changes: 10 additions & 0 deletions documentation/custom-integrations/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
<br/>
<div class="centered" style="display: flex;
align-items: center;
gap: 20px;
font-size: 2em;
font-weight: 100;">
<img src="/logo.png" style="max-height:70px;" title="Needle Logo" alt="Needle Logo"/> +
<span style="font-size: 50px;">?!</span>
</div>

# Integrate with other tools

::: warning This page is under construction.
Expand Down
15 changes: 9 additions & 6 deletions documentation/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ Deployment is the process of making your application available to the public on

## Available Deployment Targets

- [Needle Cloud](./cloud/)
Great for spatial web apps and sharing assets.
- [Glitch](#deploy-to-glitch)
No login required, great for experimentation.
Great for experimentation and hacking on server-side code.

- [Netlify](#deploy-to-netlify)
Great for hosting your own website and custom domain names.
- [itch.io](#deploy-to-itch.io)
Expand All @@ -18,15 +21,15 @@ Deployment is the process of making your application available to the public on
Free static page hosting.
- [Vercel](#deploy-to-vercel)
Platform for frontend developers
- [Facebook Instant Games](#deploy-to-facebook-instant-games)
Games platform on Facebook and Facebook Messenger
- [FTP Upload](#deploy-to-ftp)
Deploy directly to any server with FTP support.
Deploy directly to any server with FTP support. Both FTP and SFTP are supported.
- [Build to folder](#build-to-folder)
Bring your project anywhere!
When building to a folder, you can upload the files to any web server or other hosting service.
- [Facebook Instant Games](#deploy-to-facebook-instant-games)
Games platform on Facebook and Facebook Messenger.

::: tip Feel something is missing?
Please let us know in our [discord](https://discord.needle.tools)!
Please let us know in our [forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content)!
:::

## Development Builds
Expand Down
2 changes: 1 addition & 1 deletion documentation/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ To fix this you can:
- Remove the `GltfObject` in the referenced Prefab or Scene
- Rename the GameObject with the component that loads the referenced scenes

If this doesn't fix the problem please ask [in our discord](https://discord.needle.tools).
If this doesn't fix the problem please ask [in our forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content).

## My scene is not loading and the console contains a warning with 'circular references' or 'failed to update active state'
Please see the [circular reference error](#circular-reference-error) section.
Expand Down
2 changes: 1 addition & 1 deletion documentation/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,5 +161,5 @@ Now that you've installed Needle Engine, you're ready to dive deeper into projec
- [Scripting Reference](../scripting.md)

In case you need troubleshooting help, please see the [Questions and Answers – FAQ](../faq.md) section.
We welcome you to join our [Forum](https://forum.needle.tools) and [Discord Community](https://discord.needle.tools).
We welcome you to join our [Forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content) and [Discord Community](https://discord.needle.tools).

2 changes: 1 addition & 1 deletion documentation/scripting-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can also export an array of clips.
@[code ts twoslash](@code/component-unityevent.ts)
::: tip
EventList events are also invoked on the component level. This means you can also subscribe to the event declared above using ``myComponent.addEventListener("my-event", evt => {...})`` as well.
This is an experimental feature. Please provide feedback in our [forum](https://forum.needle.tools)
This is an experimental feature. Please provide feedback in our [forum](https://forum.needle.tools/?utm_source=needle_docs&utm_content=content)
:::


Expand Down
2 changes: 1 addition & 1 deletion documentation/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Ask any question about Needle Engine, web development or our editor integrations

## Discord

Chat with the community and share your projects in [Needle Discord](https://discord.needle.tools)
Chat with the community and share your projects in [Needle Discord](https://discord.needle.tools/?utm_source=needle_docs&utm_content=content)


## Get Inspired
Expand Down
9 changes: 8 additions & 1 deletion documentation/unity/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@ title: Needle Engine for Unity
editLink: true
---
<br/>
<img src="/imgs/unity-logo.webp" style="max-height:70px;" />
<div class="centered" style="display: flex;
align-items: center;
gap: 20px;
font-size: 2em;
font-weight: 100;">
<img src="/logo.png" style="max-height:70px;" title="Needle Logo" alt="Needle Logo"/> +
<img src="/imgs/unity-logo.webp" style="max-height:70px;" />
</div>

# Needle Engine for Unity

Expand Down

0 comments on commit 7f77d5b

Please sign in to comment.