Skip to content

Commit c2db7b3

Browse files
committed
Changed FAQs as accordions
1 parent 8b40aa0 commit c2db7b3

File tree

2 files changed

+86
-84
lines changed

2 files changed

+86
-84
lines changed

docs/faq.md

Lines changed: 84 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -2,134 +2,135 @@
22

33
## General Questions
44

5-
### What is the glTF/glb importer for Maya?
6-
The glTF/glb importer for Maya is a plugin that allows you to import glTF (GL Transmission Format) and glb (Binary glTF) files directly into Autodesk Maya. This enables seamless integration of 3D assets that follow the glTF standard into your Maya workflow.
5+
??? question "What is the glTF/glb importer for Maya?"
6+
The glTF/glb importer for Maya is a plugin that allows you to import glTF (GL Transmission Format) and glb (Binary glTF) files directly into Autodesk Maya. This enables seamless integration of 3D assets that follow the glTF standard into your Maya workflow.
77

8-
### What versions of Maya are supported?
9-
The plugin supports various versions of Maya. Please check the [Dependencies Installation](dependencies_installation.md) page for specific version compatibility information.
8+
??? question "What versions of Maya are supported?"
9+
The plugin supports various versions of Maya. Please check the [Dependencies Installation](dependencies_installation.md) page for specific version compatibility information.
1010

1111
## Installation Questions
1212

13-
### Why am I getting installation errors?
14-
Common installation issues can be resolved by:
13+
??? question "Why am I getting installation errors?"
14+
Common installation issues can be resolved by:
1515

16-
1. Ensuring you have the correct Maya version
17-
2. Verifying all dependencies are properly installed
18-
3. Checking that you have sufficient permissions to install plugins
19-
4. Following the step-by-step instructions in [Plugin Installation](plugin_installation.md)
16+
1. Ensuring you have the correct Maya version
17+
2. Verifying all dependencies are properly installed
18+
3. Checking that you have sufficient permissions to install plugins
19+
4. Following the step-by-step instructions in [Plugin Installation](plugin_installation.md)
2020

21-
### Do I need to install additional dependencies?
22-
Yes, the plugin requires certain dependencies to function properly. Please follow the complete guide in [Dependencies Installation](dependencies_installation.md) before installing the plugin.
21+
??? question "Do I need to install additional dependencies?"
22+
Yes, the plugin requires certain dependencies to function properly. Please follow the complete guide in [Dependencies Installation](dependencies_installation.md) before installing the plugin.
2323

24-
### Where should I install the plugin files?
25-
The plugin should be installed in Maya's plugin directory. Detailed installation paths and instructions are provided in the [Plugin Installation](plugin_installation.md) guide.
24+
??? question "Where should I install the plugin files?"
25+
The plugin should be installed in Maya's plugin directory. Detailed installation paths and instructions are provided in the [Plugin Installation](plugin_installation.md) guide.
2626

2727
## Import Questions
2828

29-
### What file formats are supported?
30-
The plugin supports both:
31-
- **.gltf** files (JSON format with external assets)
32-
- **.glb** files (binary format with embedded assets)
29+
??? question "What file formats are supported?"
30+
The plugin supports both:
31+
32+
- **.gltf** files (JSON format with external assets)
33+
- **.glb** files (binary format with embedded assets)
3334

34-
### Why isn't my glTF/glb file importing correctly?
35-
Several factors can affect import success:
35+
??? question "Why isn't my glTF/glb file importing correctly?"
36+
Several factors can affect import success:
3637

37-
1. **File compatibility**: Check [Asset Compatibility and Workarounds](compatibility_and_workarounds.md)
38-
2. **File format issues**: Ensure your file follows glTF 2.0 specifications
39-
3. **Missing textures**: Verify all referenced textures are available
40-
4. **Large file size**: Very large files may require specific settings
38+
1. **File compatibility**: Check [Asset Compatibility and Workarounds](compatibility_and_workarounds.md)
39+
2. **File format issues**: Ensure your file follows glTF 2.0 specifications
40+
3. **Missing textures**: Verify all referenced textures are available
41+
4. **Large file size**: Very large files may require specific settings
4142

42-
### Can I import animations from glTF/glb files?
43-
Yes! The plugin supports animation import. Configure your animation settings using the [Animation Settings](animation_settings.md) options before importing.
43+
??? question "Can I import animations from glTF/glb files?"
44+
Yes! The plugin supports animation import. Configure your animation settings using the [Animation Settings](animation_settings.md) options before importing.
4445

45-
### How do I handle material variants?
46-
Material variants are supported through the [Show Material Variants](show_material_variants.md) feature. This allows you to switch between different material configurations defined in your glTF file.
46+
??? question "How do I handle material variants?"
47+
Material variants are supported through the [Show Material Variants](show_material_variants.md) feature. This allows you to switch between different material configurations defined in your glTF file.
4748

4849
## Material Questions
4950

50-
### Why don't my materials look correct after import?
51-
Material appearance can be affected by:
51+
??? question "Why don't my materials look correct after import?"
52+
Material appearance can be affected by:
5253

53-
1. **Material settings**: Adjust options in [Material Settings](material_settings.md)
54-
2. **Texture paths**: Ensure textures are properly linked
55-
3. **Maya's material system**: Some glTF material features may need manual adjustment
56-
4. **Lighting setup**: Your Maya scene lighting affects material appearance
54+
1. **Material settings**: Adjust options in [Material Settings](material_settings.md)
55+
2. **Texture paths**: Ensure textures are properly linked
56+
3. **Maya's material system**: Some glTF material features may need manual adjustment
57+
4. **Lighting setup**: Your Maya scene lighting affects material appearance
5758

58-
### Can I extract textures during import?
59-
Yes, you can extract and save textures using the [Image Extraction](image_extraction.md) feature. This is particularly useful for glb files where textures are embedded.
59+
??? question "Can I extract textures during import?"
60+
Yes, you can extract and save textures using the [Image Extraction](image_extraction.md) feature. This is particularly useful for glb files where textures are embedded.
6061

61-
### How do I handle PBR materials?
62-
The plugin attempts to convert PBR (Physically Based Rendering) materials to Maya-compatible materials. Some manual adjustment may be required for optimal results.
62+
??? question "How do I handle PBR materials?"
63+
The plugin attempts to convert PBR (Physically Based Rendering) materials to Maya-compatible materials. Some manual adjustment may be required for optimal results.
6364

6465
## Performance Questions
6566

66-
### Why is my import taking so long?
67-
Import time can be affected by:
67+
??? question "Why is my import taking so long?"
68+
Import time can be affected by:
6869

69-
1. **File size**: Larger files take more time to process
70-
2. **Geometry complexity**: High-poly models require more processing
71-
3. **Texture resolution**: Large textures increase import time
72-
4. **Computer specifications**: Available RAM and CPU power
70+
1. **File size**: Larger files take more time to process
71+
2. **Geometry complexity**: High-poly models require more processing
72+
3. **Texture resolution**: Large textures increase import time
73+
4. **Computer specifications**: Available RAM and CPU power
7374

74-
### Can I optimize import performance?
75-
Yes, you can improve performance by:
75+
??? question "Can I optimize import performance?"
76+
Yes, you can improve performance by:
7677

77-
1. Using appropriate [Geometry Options](geometry_options.md)
78-
2. Adjusting texture import settings
79-
4. Using [File Type Specific Options](file_type_specific_options.md)
78+
1. Using appropriate [Geometry Options](geometry_options.md)
79+
2. Adjusting texture import settings
80+
3. Using [File Type Specific Options](file_type_specific_options.md)
8081

8182
## Troubleshooting
8283

83-
### The plugin menu doesn't appear in Maya
84-
If the [GLB/GLTF Menu](glb_gltf_menu.md) is not visible:
84+
??? question "The plugin menu doesn't appear in Maya"
85+
If the [GLB/GLTF Menu](glb_gltf_menu.md) is not visible:
8586

86-
1. Verify the plugin is properly installed
87-
2. Check that the plugin is loaded in Maya's Plugin Manager
88-
3. Restart Maya after installation
89-
4. Check Maya's script editor for error messages
87+
1. Verify the plugin is properly installed
88+
2. Check that the plugin is loaded in Maya's Plugin Manager
89+
3. Restart Maya after installation
90+
4. Check Maya's script editor for error messages
9091

91-
### I'm getting error messages during import
92-
Common solutions:
92+
??? question "I'm getting error messages during import"
93+
Common solutions:
9394

94-
1. Check the [Limitations and Known Issues](limitations.md) page
95-
2. Verify your file meets glTF 2.0 specifications
96-
3. Try importing a simpler test file first
97-
4. Check Maya's script editor for detailed error information
95+
1. Check the [Limitations and Known Issues](limitations.md) page
96+
2. Verify your file meets glTF 2.0 specifications
97+
3. Try importing a simpler test file first
98+
4. Check Maya's script editor for detailed error information
9899

99-
### My animations aren't playing correctly
100-
Animation issues can often be resolved by:
100+
??? question "My animations aren't playing correctly"
101+
Animation issues can often be resolved by:
101102

102-
1. Checking [Animation Settings](animation_settings.md) configuration
103-
2. Using [Show Animation Clips](show_animation_clips.md) to manage multiple animations
104-
3. Verifying timeline settings in Maya
105-
4. Checking for keyframe import options
103+
1. Checking [Animation Settings](animation_settings.md) configuration
104+
2. Using [Show Animation Clips](show_animation_clips.md) to manage multiple animations
105+
3. Verifying timeline settings in Maya
106+
4. Checking for keyframe import options
106107

107108
## Advanced Usage
108109

109-
### Can I batch import multiple files?
110-
The plugin focuses on individual file import. For batch operations, you may need to use Maya's scripting capabilities or import files one at a time.
110+
??? question "Can I batch import multiple files?"
111+
The plugin focuses on individual file import. For batch operations, you may need to use Maya's scripting capabilities or import files one at a time.
111112

112-
### How do I handle very large glTF scenes?
113-
For large scenes:
113+
??? question "How do I handle very large glTF scenes?"
114+
For large scenes:
114115

115-
1. Consider splitting the scene into smaller files
116-
2. Use selective import options
117-
3. Optimize geometry before import
118-
4. Monitor Maya's memory usage
116+
1. Consider splitting the scene into smaller files
117+
2. Use selective import options
118+
3. Optimize geometry before import
119+
4. Monitor Maya's memory usage
119120

120-
### Can I modify import settings after import?
121-
Import settings apply during the import process. To change settings, you'll need to re-import the file with new configuration options.
121+
??? question "Can I modify import settings after import?"
122+
Import settings apply during the import process. To change settings, you'll need to re-import the file with new configuration options.
122123

123124
## Getting Help
124125

125-
### Where can I find more technical information?
126-
Detailed technical information is available in the [Technical Details](technical_details.md) section.
126+
??? question "Where can I find more technical information?"
127+
Detailed technical information is available in the [Technical Details](technical_details.md) section.
127128

128-
### How do I report bugs or request features?
129-
Please refer to the project repository for information on reporting issues and requesting new features.
129+
??? question "How do I report bugs or request features?"
130+
Please refer to the project repository for information on reporting issues and requesting new features.
130131

131-
### Are there example files I can use for testing?
132-
Check the glTF sample repository or create simple test files to verify your installation and understand the import process.
132+
??? question "Are there example files I can use for testing?"
133+
Check the glTF sample repository or create simple test files to verify your installation and understand the import process.
133134

134135
---
135136

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,14 @@ theme:
5050

5151
markdown_extensions:
5252
- attr_list
53+
- pymdownx.details
54+
- pymdownx.superfences
5355
- pymdownx.highlight:
5456
anchor_linenums: true
5557
line_spans: __span
5658
pygments_lang_class: true
5759
- pymdownx.inlinehilite
5860
- pymdownx.snippets
59-
- pymdownx.superfences
6061
- pymdownx.emoji:
6162
emoji_index: !!python/name:material.extensions.emoji.twemoji
6263
emoji_generator: !!python/name:material.extensions.emoji.to_svg

0 commit comments

Comments
 (0)