Community
Bifrost Forum
Welcome to the Bifrost Forum. This is the place for artists using Bifrost to ask and answer questions, browse popular topics, and share knowledge about creating effects procedurally using Bifrost. You can also visit the Bifrost Community on AREA to download an array of ready-to-use graphs, read Bifrost news and updates, and find the latest tutorials.
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Adding .md docs to compounds

5 REPLIES 5
SOLVED
Reply
Message 1 of 6
mjcg91
665 Views, 5 Replies

Adding .md docs to compounds

Hi,

 

I'm currently writing the documentation for all my compounds, but I've been struggling to get anything to display to display in the info that. I realized that it was not as simple as giving the .md file the same name, and having Bifrost to be able to find that file. I have found some metadata inside in some of the built-in compounds:

 

                    "metaName": "documentation",
                    "metaValue": "../docs/${language}/construct_strands.md",
                    "metaType": "string"

1. Are there any command line that could automate this task?  Or hand editing the .json file it currently the only way to link a compound and its corresponding documentation ?

 

2. Are there any documentation somewhere about adding compound documentation, like important things to know ?

 

Thanks.

Maxime

 

Maxime Jeanmougin - Technical Artist
https://maximejeanmougin.com

Join the Bifrost Addicts community on Discord:
https://discord.gg/bifrost-addicts
5 REPLIES 5
Message 2 of 6
Grahame_Fuller
in reply to: mjcg91

Hi Maxime,

 

For now, you need to add the metadata manually to the .json files. This is not currently documented. We hope to make it part of the process for publishing compounds, as it is now for publishing graphs.

 

The metavalue is the path to the .md file, relative to the .json file's location. Use / instead of \ so that it works on Linux and macOS as well as Windows. The ${language} token that you see in installed compounds gets replaced by ENU/CHS/JPN depending on the Maya's language UI — you can leave it out unless you are planning to provide translated versions of your documentation, and simply point to one file instead. I'd suggest putting it together with the .json file in a subdirectory to make it easy to zip and share.

 

For the documentation file, use GitHib-flavor Markdown.

 

I hope that helps,

gray


Grahame Fuller
Learning Content Developer
Message 3 of 6
mjcg91
in reply to: Grahame_Fuller

Gray,

 

Thank you, this is quite helpful. I'll work on it using the method you suggested until we can use the publisher.

 

Best,

Maxime

Maxime Jeanmougin - Technical Artist
https://maximejeanmougin.com

Join the Bifrost Addicts community on Discord:
https://discord.gg/bifrost-addicts
Message 4 of 6
mjcg91
in reply to: mjcg91

It looks like there is a limitation on the number of sub-folders you can have in the "metaValue". At some point it will not load the .md file anymore. 

 

This doesn't work:

                {
                    "metaName": "documentation",
                    "metaType": "string",
                    "metaValue": "../geometry/mesh/docs/${language}/create_mesh_from_uv.md"
                },

This doesn't work:

                {
                    "metaName": "documentation",
                    "metaType": "string",
                    "metaValue": "..geometry/mesh/docs/create_mesh_from_uv.md"
                },

But this works:

                {
                    "metaName": "documentation",
                    "metaType": "string",
                    "metaValue": "../mesh/docs/${language}/create_mesh_from_uv.md"
                },

 

All I did to fix it was adding the sub-folder inside my lib_config file. It is weird because It detected all my .md file inside another sub-folder. but if I add an extra sub-folder, then it doesn't load it anymore.

 

Maxime Jeanmougin - Technical Artist
https://maximejeanmougin.com

Join the Bifrost Addicts community on Discord:
https://discord.gg/bifrost-addicts
Message 5 of 6
mjcg91
in reply to: mjcg91

Nevermind, I found the proper way to do it. I simply replaced the first sub-folder with double slash like this:

                {
                    "metaName": "documentation",
                    "metaType": "string",
                    "metaValue": "..//mesh/docs/${language}/create_mesh_from_uv.md"
                },

 

I guess you have to do this until it reachs the location where the .json files are located.

 

Maxime Jeanmougin - Technical Artist
https://maximejeanmougin.com

Join the Bifrost Addicts community on Discord:
https://discord.gg/bifrost-addicts
Message 6 of 6
aaronfross
in reply to: Grahame_Fuller

Can we please get this added to the Bifrost docs? I found Matt Chan's video tutorial, but had to figure out a lot of stuff on my own.

Can't find what you're looking for? Ask the community or share your knowledge.

Post to forums