You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description:
Currently, the documentation includes embedded code examples directly within the markdown files. To improve maintainability and consistency, it would be beneficial to consolidate code examples using Hugo shortcodes. This approach allows code examples to be included from separate files, making it easier to update and manage them.
Proposed Solution:
Use Hugo's readFile shortcode to include code examples from separate files.
Organize code examples in a dedicated directory within the repository.
Update the documentation to reference the code examples using the readFile shortcode.
Benefits:
Improved maintainability: Code examples can be updated independently of the documentation.
Consistency: Ensures that code examples are consistent across different sections of the documentation.
Clarity: Separates content from code, making the documentation easier to read and navigate.
For more details on how to implement this, please refer to this guide.
The text was updated successfully, but these errors were encountered:
Description:
Currently, the documentation includes embedded code examples directly within the markdown files. To improve maintainability and consistency, it would be beneficial to consolidate code examples using Hugo shortcodes. This approach allows code examples to be included from separate files, making it easier to update and manage them.
Proposed Solution:
readFile
shortcode to include code examples from separate files.readFile
shortcode.Benefits:
For more details on how to implement this, please refer to this guide.
The text was updated successfully, but these errors were encountered: