Skip to content

Commit

Permalink
doc: improve css + add audio
Browse files Browse the repository at this point in the history
  • Loading branch information
Gugustinette committed Sep 2, 2024
1 parent 2421dc6 commit ca6e10d
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ export default defineConfig({
{ text: 'Events', collapsed: true, items: [
{ text: 'Keyboard', link: '/guide/events/keyboard' },
] },
{ text: 'Audio', collapsed: true, items: [
{ text: 'Introduction', link: '/guide/audio/introduction' },
] },
],
},
{
Expand Down
13 changes: 13 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
--fibbo-yellow: #F5EA70;
--fibbo-black: #0A0901;
--fibbo-black-300: #1A151E;
--fibbo-black-600: #2A252C;
--fibbo-secondary: #FFFBE4;
--fibbo-secondary-300: #f4eecc;

Expand All @@ -29,6 +30,12 @@
/* Sidebar */
--vp-sidebar-bg-color: var(--fibbo-secondary);

/* Grey Code Background */
--vp-code-bg: var(--fibbo-secondary-300);

/* Divider */
--vp-c-divider: var(--fibbo-secondary-300);

/* Black */
--vp-c-black: #0E0317;
}
Expand Down Expand Up @@ -62,6 +69,12 @@
/* Sidebar */
--vp-sidebar-bg-color: var(--fibbo-black);

/* Grey Code Background */
--vp-code-bg: var(--fibbo-black-300);

/* Divider */
--vp-c-divider: var(--fibbo-black-600);

/* White */
--vp-c-white: var(--fibbo-secondary);
}
4 changes: 3 additions & 1 deletion docs/guide/3d/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Introduction

Models are the core of any 3D application. They are the objects that are rendered in the scene. They can be simple shapes like cubes or spheres, but most of the time, they are complex 3D models that are created in a 3D modeling software like [Blender](https://www.blender.org/).
Models are the core of any 3D application. They are the objects that are rendered in the scene.

They can be simple shapes like cubes or spheres ; but in Fibbo, we will use the term to refer to complex 3D models that are created in a 3D modeling software like [Blender](https://www.blender.org/).

Here is a brief overview of the most common 3D models file formats :
- [.fbx](https://en.wikipedia.org/wiki/FBX) : A proprietary file format developed by Autodesk. It is widely used in the game industry.
Expand Down
11 changes: 11 additions & 0 deletions docs/guide/audio/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Audio <Badge type="warning" text="work in progress" />

Audio is still not supported natively in Fibbo, so for now, you should consider using third-party libraries to manage audio in your Fibbo application.

Here are some libraries that you can use to manage audio on the web :

- [Howler.js](https://github.com/goldfire/howler.js)
- [Tone.js](https://github.com/Tonejs/Tone.js)
- [Pizzicato.js](https://github.com/alemangui/pizzicato)

You can find more libraries on the [awesome-audio](https://github.com/notthetup/awesome-webaudio) list.

0 comments on commit ca6e10d

Please sign in to comment.