generate a documentation page for every components#350
Conversation
| components.forEach((component) => { | ||
| // eslint-disable-next-line prettier/prettier | ||
| const componentFile = 'Core' + component.type[0].toUpperCase() + component.type.slice(1) + '.vue'; | ||
| component.source_link = `ui/src/core_components/${component.category.toLowerCase()}/${componentFile}`; |
There was a problem hiding this comment.
I am not satisfied with this solution. @ramedina86 / @raaymax Do you have a recommendation for properly retrieving the path of a component?
There was a problem hiding this comment.
Only other solution I can come up with is adding something like this
_source: import.meta.url.split("core_components")[1],to every component we have
There was a problem hiding this comment.
Thanks for the feedback. I think I'll keep this code and add automatic tests to enforce the component file tree structure. I am convinced adding this line into all the component.
There was a problem hiding this comment.
I think I found even better solution! I need to test it first tho...
There was a problem hiding this comment.
Great job with this @raaymax , the original solution would have indeed been rather fragile.
ee5505a to
b634463
Compare
0e4bfde to
0c0d0c0
Compare
|
I have to edit the option with
|
|
The options should be visible in the comment after attributes
|
057e40f to
122d916
Compare
|
add the documentation field when it's present below the image |
856adf8 to
65db785
Compare
What did you mean by this? |
|
@FabienArcellier can you please merge dev into your branch? Latest changes by Mateusz create conflicts here: |
df8b70b to
8d1ea56
Compare
refactoring generators to have one generator per usecase.
generate md files with title and description
generate md files with syntax highlighting for event
generate dedicated page to component list
add the default value add the link to the source code
* generate low code usage
* generate low code usage
* generate low code usage
* refact: remove independant datasource
* compile documentation from component
feat: order options
feat: set options in signature
fix: fix link of backend driven ui
* fix: fix link of backend driven ui * set developper commande to build en run documentation from alfred
8d1ea56 to
0e45ba5
Compare
It was not practical to have different order when reading it. |
Generate a dedicated space to navigate inside existing components