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
If you want to update the documentation, change the corresponding files in /docs/products/. To add documentation files, place them in the appropriate product section and do not forget to add them to the sidebar (add the data to the /config/content/sidebarContentConfig.ts to the appropriate section). If a new documentation page requires images, add them to the appropriate folder in /assets/images/
Dev-portal-2 uses a library module with clean-URLs and for its correct operation it is necessary to store documents correctly.
Add all documents in individual folders and the entry point must be a file index.md
As shown in the diagram:
If there are other files inside the folder, except index.md then the name of this folder should start with a capital letter. Otherwise, with lowercase.
Add an image
To add an image to your document, please follow these steps:
Upload the file to public/assets/images/products/name_of_product/name_of_subcategory/title_image
Add next code:
"><ImageViewer src='/assets/images/products/path_to_your_file' alt='alt for image' />
If you want to add a description to an image, you should use the pictureTitle attribute. For example:
If you want to add a new one .vue component, you need to add these files to the appropriate folder in the /components/ section or create a new folder if the existing ones are not suitable. Do not forget import new components in /.vitepress/theme/index.ts
To use the Accordion element, use the following syntax
<AccordionItem:id="idHere"> <template#title> title here template> <template#description> content here template> AccordionItem>
To create an anchor link to an object, set the value of the parameter :id;
Use the tag to indicate the section header, for example, a frequently asked question;
Use the tag to indicate the part of the section to be disclosed, for example, the answer to a frequently asked question.
Update existing config
if you want to change an existing config, you need to find the required file in the /config/content folder and change the required part. Important: Each config file has its own structure and in order not to cause conflicts, you need to adhere to it.
Also, some config files require an icon, they need to be added to an existing file (/assets/images/sprite.svg) and add an id to them