blender-studio-pipeline/docs/.vitepress/config.ts
2023-12-14 18:58:35 +01:00

246 lines
9.3 KiB
TypeScript

// Imports for overriding internal components
import { fileURLToPath, URL } from 'node:url'
import { defineConfig } from 'vitepress'
import { html5Media } from 'markdown-it-html5-media'
const studioURL = 'https://studio.blender.org'
// https://vitepress.dev/reference/site-config
export default defineConfig({
base: '/pipeline/',
title: "Blender Studio",
description: "Documentation for the Blender Studio pipeline and tools.",
lastUpdated: true,
cleanUrls: true,
srcExclude: ['**/README',],
head: [
[
'script',
{
defer: '',
'data-domain': 'studio.blender.org',
src: 'https://analytics.blender.org/js/script.js'
}
],
],
themeConfig: {
logo: {
/*
Logo is injected from Vue component NavBarGlobal
light: '/blender-studio-logo-black.svg',
dark: '/blender-studio-logo-white.svg'
*/
},
siteTitle: false,
footer: {
copyright: '(CC) Blender Foundation | studio.blender.org'
},
editLink: {
pattern: 'https://projects.blender.org/studio/blender-studio-tools/_edit/master/docs/:path'
},
search: {
provider: 'local'
},
// https://vitepress.dev/reference/default-theme-config
nav: [
/*
Nav is injected from Vue component NavBarGlobal
{ text: 'Films', link: `${studioURL}/films` },
{ text: 'Training', link: `${studioURL}/training` },
{ text: 'Blog', link: `${studioURL}/blog` },
{ text: 'Pipeline', link: '/' },
{ text: 'Characters', link: `${studioURL}/characters`, }
*/
],
sidebar: [
{
text: 'Pipeline Overview',
items: [
{ text: 'Introduction', link: '/pipeline-overview/introduction'},
{ text: 'Design Principles', link: '/pipeline-overview/design-principles'},
{
text: 'Organization',
collapsed: true,
items: [
{ text: 'Infrastructure', link: '/pipeline-overview/organization/infrastructure'},
{ text: 'Task Review', link: '/pipeline-overview/organization/task-review'},
]
},
{
text: 'Pre-Production',
collapsed: true,
items: [
{ text: 'Storyboard', link: '/pipeline-overview/pre-production/storyboard'},
{ text: 'Editorial', link: '/pipeline-overview/pre-production/editorial'},
{ text: 'Previz', link: '/pipeline-overview/pre-production/previz'},
{ text: 'Research and Development', link: '/pipeline-overview/pre-production/research-and-development'},
{ text: 'Concept and Design', link: '/pipeline-overview/pre-production/concept-and-design'},
]
},
{
text: 'Asset Creation',
collapsed: true,
items: [
{ text: 'Modeling and Sculpting', link: '/pipeline-overview/asset-creation/modeling'},
{ text: 'Shading', link: '/pipeline-overview/asset-creation/shading'},
{ text: 'Rigging', link: '/pipeline-overview/asset-creation/rigging'},
{ text: 'Animation Testing', link: '/pipeline-overview/asset-creation/animation-testing'},
{ text: '2D Assets', link: '/pipeline-overview/asset-creation/2d-assets'},
]
},
{
text: 'Shot Production',
collapsed: true,
items: [
{ text: 'Shot Assembly', link: '/pipeline-overview/shot-production/shot-assembly'},
{ text: 'Layout', link: '/pipeline-overview/shot-production/layout'},
{ text: 'Animation', link: '/pipeline-overview/shot-production/animation'},
{ text: 'Lighting', link: '/pipeline-overview/shot-production/lighting'},
{ text: 'Effects', link: '/pipeline-overview/shot-production/effects'},
{ text: 'Rendering', link: '/pipeline-overview/shot-production/rendering'},
{ text: 'Coloring', link: '/pipeline-overview/shot-production/coloring'},
]
},
{ text: 'Publishing', link: '/pipeline-overview/publishing'},
]
},
{
text: 'Add-ons',
link:'/addons/overview',
collapsed: true,
items: [
{ text: 'Anim Cupboard', link: '/addons/anim_cupboard'},
{ text: 'Asset Pipeline', link: '/addons/asset_pipeline'},
{ text: 'Blender Kitsu', link: '/addons/blender_kitsu'},
{ text: 'Blender SVN', link: '/addons/blender_svn'},
{ text: 'Blender Gizmos', link: '/addons/bone_gizmos'},
{ text: 'Cache Manager', link: '/addons/cache_manager'},
{ text: 'Contact Sheet', link: '/addons/contactsheet'},
{ text: 'Easy Weights', link: '/addons/easy_weights'},
{ text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'},
{ text: 'Grase Converter', link: '/addons/grease_converter'},
{ text: 'Lattice Magic', link: '/addons/lattice_magic'},
{ text: 'Lighting Overrider', link: '/addons/lighting_overrider'},
{ text: 'Pose Shape Keys', link: '/addons/pose_shape_keys'},
{ text: 'Render Review', link: '/addons/render_review'},
]
},
{
text: 'Naming Conventions',
collapsed: true,
items: [
{ text: 'Introduction', link: '/naming-conventions/introduction'},
{ text: 'File Types', link: '/naming-conventions/file-types'},
{ text: 'In-file Prefixes', link: '/naming-conventions/in-file-prefixes'},
{ text: 'Examples', link: '/naming-conventions/examples'},
{ text: 'Shared Folder Structure', link: '/naming-conventions/shared-folder-structure'},
{ text: 'SVN Folder Structure', link: '/naming-conventions/svn-folder-structure'},
]
},
{
text: 'User Guide',
collapsed: false,
items: [
{
text: 'Project Tools',
collapsed: true,
items: [
{ text: 'Project Overview', link: '/user-guide/project_tools/project-overview' },
{ text: 'Project Usage', link: '/user-guide/project_tools/project-usage'},
{ text: 'Project Blender', link: '/user-guide/project_tools/project-blender' },
],
},
{
text: 'Organization',
collapsed: true,
items: [
{ text: 'Planning', link: '/user-guide/organization/planning' },
{ text: 'Task Review', link: '/user-guide/organization/task-review' },
],
},
{ text: 'Debugging', link: '/user-guide/debugging' },
{ text: 'Kitsu', link: '/user-guide/kitsu' },
],
},
{
text: 'TD Guide',
collapsed: true,
items: [
{text: 'Project Tools Setup', link: '/td-guide/project-tools-setup'},
]
},
{
text: 'Archive',
collapsed: true,
items: [
{text: 'Pipeline Proposal', link: '/archive/pipeline-proposal-2019/introduction'},
{text: 'Attact Updates', link: '/archive/pipeline-proposal-2019/attract-improvements'},
{text: 'Task Companion Add-on', link: '/archive/pipeline-proposal-2019/task-companion-add-on'},
{text: 'Shot Caching', link: '/archive/pipeline-proposal-2019/shot-caching/introduction', items: [
{text: 'Add-on', link: '/archive/pipeline-proposal-2019/shot-caching/add-on', items: [
{text: 'User Stories', link: '/archive/pipeline-proposal-2019/shot-caching/user-stories'},
{text: 'Structural Ideas', link: '/archive/pipeline-proposal-2019/shot-caching/structural-ideas'}
]},
{text: 'Issues', link: '/archive/pipeline-proposal-2019/shot-caching/issues'},
]},
{text: 'Asset Publishing', link: '/archive/pipeline-proposal-2019/asset-publishing/introduction'},
{text: 'Character Pipeline Assistant', link: '/archive/pipeline-proposal-2019/asset-publishing/character-pipeline-assistant'},
],
},
{
text: 'Gentoo',
collapsed: true,
items: [
{
text: 'TD',
collapsed: false,
items: [
{ text: 'Overview', link: '/gentoo/td/overview'},
{ text: 'Installation', link: '/gentoo/td/installation'},
{ text: 'Maintenance', link: '/gentoo/td/maintaince'},
{ text: 'Render Farm', link: '/gentoo/td/render_farm'},
],
},
{
text: 'User',
collapsed: false,
items: [
{ text: 'Introduction', link: '/gentoo/user/introduction' },
{ text: 'Installing Software', link: '/gentoo/user/installing-software' },
{ text: 'Running Blender', link: '/gentoo/user/running-blender' },
{ text: 'SVN', link: '/gentoo/user/svn' },
{ text: 'Troubleshooting', link: '/gentoo/user/troubleshooting' },
]
},
],
},
],
},
markdown: {
config: (md) => {
// Enable the markdown-it-html5-media plugin
md.use(html5Media)
}
},
// Override internal component 'VPNavBar'
vite: {
resolve: {
alias: [
{
find: /^.*\/VPNavBar\.vue$/,
replacement: fileURLToPath(
new URL('./components/NavBarGlobal.vue', import.meta.url)
)
}
]
}
}
})