-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: markdown doc #365
feat: markdown doc #365
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #365 +/- ##
=======================================
Coverage 92.18% 92.18%
=======================================
Files 95 95
Lines 2111 2111
Branches 385 385
=======================================
Hits 1946 1946
Misses 95 95
Partials 70 70
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
963249c
to
92a80ad
Compare
a1c9ffb
to
37d1c86
Compare
37d1c86
to
5222dec
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the MD integration @quentinderoubaix.
As discussed, I think we should have all MDs at root level to make it easy to have a look to the documentation directly from IDE / github (in a second step with a slug convention).
|
||
AgnosUI provides two flavours of the widgets for you to choose from: | ||
|
||
- **Headless**: The {$selectedFramework$}-headless package contains the headless functionality of the widget library. It can be used with any front-end CSS framework. It uses the core of AgnosUI which is framework agnostic. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we use variables in the MD like {$selectedFramework$}
, I think you will need a custom renderer else it will be rendered as html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
thx for the review @andreascorti ! |
No description provided.