-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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(quasar): add docsUrl to API definition #4045
feat(quasar): add docsUrl to API definition #4045
Conversation
Wow. Congrats on this!!! Great job
|
Thanks. Will adjust it to support |
Just a dumb question: how hard would it be to have
$ quasar api search ${search_term}
|
That's a VERY nice idea, and not hard at all. Just a matter of reading all API file names (quasar/dist/api/*.json) and string filtering them. If it will be another command, I can make another PR. |
Oh please, do it.
…On Sun, 5 May 2019, 00:13 Lucas Fernandes Nogueira, < ***@***.***> wrote:
Just a dumb question: how hard would it be to have $ quasar api search
${search_term}
That's a VERY nice idea, and not hard at all. Just a matter of reading all
API file names (quasar/dist/api/*.json) and string filtering them. If it
will be another command, I can make another PR.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#4045 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AIM4G6AYSEDHOFXRIWKGEWLPTYDAZANCNFSM4HKZYORA>
.
|
Another thing that is missing here: can this command read the Quasar build config and get the user preferred browser? I've tried but couldn't do it. |
Fixed with latest commits. Also fixed running with app extension API. This PR is now done unless you want something else. |
TODO: move default "docs" values to the build command. |
7707ffc
to
b8d7b16
Compare
quasar docs
command@@ -117,6 +118,11 @@ const objectTypes = { | |||
required: [ 'desc' ] | |||
}, | |||
|
|||
meta: { | |||
props: [ 'docsRoute', 'docsPage', 'docsApiAnchor' ], |
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.
Let's use one prop only "docsUrl" with full URL. For now, point to https://v1.quasar.dev
. Example:
meta: {
docsUrl: 'https://v1.quasar.dev/......'
}
* quasar docs command * add docs * add sections * add sections to command * fix open browser * pass supplier to docs function * read quasar conf for open browser * fix command with app extensions API * open-browser using its own logger * fix Ripple docs * move "docs" defaults to build.api.js * fix DocApi trying to render docs field * fix QUploaderAddTrigger page * feat(api) change "docs" key to "meta" * fix(api) definitions for meta * fix(api) definitions for meta & `quasar docs` usage * feat(api) move docs opening to describe command and prefix API with "docs" * feat(docs) add new quasar describe option * fix(quasar) code review updates * fix(app) describe command
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
dev
branch and not themaster
branchfix: #xxx[,#xxx]
, where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information:
The
quasar docs
command receives a Quasar component/directive/plugin and opens the docs page. It also supports app extensions. It also has a --api option, which uses the API table anchor as URL.Credits to @hawkeye64 for the idea.
EDIT: added options to open sections (components, plugins, directives and extensions), e.g.
quasar docs components