Skip to content

Commit e6aaa55

Browse files
committed
⚡ fix broken documentation
1 parent bb14334 commit e6aaa55

File tree

3 files changed

+80
-1
lines changed

3 files changed

+80
-1
lines changed

.vitepress/config.mts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import baseConfig from '../docs/.vitepress/config.mts';
2+
3+
// Allow running `vitepress build` from the repository root by pointing to the docs directory.
4+
export default {
5+
...baseConfig,
6+
srcDir: 'docs',
7+
outDir: 'docs/.vitepress/dist',
8+
tempDir: 'docs/.vitepress/.temp',
9+
cacheDir: 'docs/.vitepress/cache',
10+
};

docs/.vitepress/config.mts

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
import { defineConfig } from 'vitepress';
2+
3+
const guideSidebar = [
4+
{
5+
text: 'Guide',
6+
items: [
7+
{ text: 'Quick Start', link: '/guide/quick-start' },
8+
{ text: 'Installation', link: '/guide/installation' },
9+
],
10+
},
11+
];
12+
13+
const usageSidebar = [
14+
{
15+
text: 'Usage',
16+
items: [
17+
{ text: 'Data Structure', link: '/usage/data-structure' },
18+
{ text: 'Parameter Tuning', link: '/usage/parameter-tuning' },
19+
{ text: 'Viewers', link: '/usage/viewers' },
20+
{ text: 'Deployment', link: '/usage/deployment' },
21+
],
22+
},
23+
];
24+
25+
const workflowsSidebar = [
26+
{
27+
text: 'Workflows',
28+
items: [
29+
{ text: 'MuJoCo Warp (MJWP)', link: '/workflows/workflow-mjwp' },
30+
{ text: 'HDMI', link: '/workflows/workflow-hdmi' },
31+
{ text: 'DexMachina', link: '/workflows/workflow-dexmachina' },
32+
],
33+
},
34+
];
35+
36+
const developmentSidebar = [
37+
{
38+
text: 'Development',
39+
items: [
40+
{ text: 'Add a Robot', link: '/development/add-robot' },
41+
{ text: 'Add a Dataset', link: '/development/add-dataset' },
42+
{ text: 'Add a Simulator', link: '/development/add-simulator' },
43+
],
44+
},
45+
];
46+
47+
export default defineConfig({
48+
lang: 'en-US',
49+
title: 'SPIDER',
50+
description: 'Scalable Physics-Informed Dexterous Retargeting',
51+
base: '/spider/',
52+
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
53+
themeConfig: {
54+
nav: [
55+
{ text: 'Guide', link: '/guide/quick-start' },
56+
{ text: 'Usage', link: '/usage/data-structure' },
57+
{ text: 'Workflows', link: '/workflows/workflow-mjwp' },
58+
{ text: 'Development', link: '/development/add-robot' },
59+
{ text: 'GitHub', link: 'https://github.com/facebookresearch/spider' },
60+
],
61+
sidebar: {
62+
'/guide/': guideSidebar,
63+
'/usage/': usageSidebar,
64+
'/workflows/': workflowsSidebar,
65+
'/development/': developmentSidebar,
66+
},
67+
socialLinks: [{ icon: 'github', link: 'https://github.com/facebookresearch/spider' }],
68+
},
69+
});

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hero:
66
text: "Scalable Physics-Informed DExterous Retargeting"
77
tagline: A general framework for physics-based retargeting from human to diverse robot embodiments
88
image:
9-
src: /teaser.png
9+
src: /figs/teaser.png
1010
alt: SPIDER
1111
actions:
1212
- theme: brand

0 commit comments

Comments
 (0)