Open leoj3n opened 1 year ago
Appreciate the callout. We'll look into smoothing those things out. PR's welcome of course 😄
Linking related PR https://github.com/marko-js/tags-api-preview/pull/29 (for compile error in readme example)
Linking related PR https://github.com/marko-js/cli/pull/214 (updates npm init
command in cli readme)
@DylanPiercey looking like the primary issues with A) the readme example needing to be updated to be <let/count=0/>
and B) with the npm command needing to look like npm init marko -- --template tags-api
should take a minute to solve; think probably do what needs to be done asap since it will make a big difference for people trying to play with tags-api coming from twitter post etc.
(wip)
Thanks for your work and feedback here. I should point out that we will be working on a rework of our documentation once the tags api / Marko 6 is in official beta and outside of the preview.
--template
flag does not work.https://twitter.com/MarkoDevTeam/status/1420431542485012485
this command proposes a dialog to the user to select "Default starter app"
TODO: Twitter post should be ammended to read like that:
probably will need to see if fix can be made in https://github.com/marko-js/clialso notice suggesting a slight difference to command here: https://github.com/marko-js/cli/tree/main/packages/create#npmnpm init @marko myapp --template webpack
notice the@marko
instead of justmarko
EDIT: proposed changes here https://github.com/marko-js/cli/pull/214Example code errors
so after
--template tags-api
fails causing regular marko5 app user may go ahead andnpm install @marko/tags-api-preview
then they may try copy/paste example from readme at https://github.com/marko-js/tags-api-preview#examplewhich will fail to compile at which point developer user might say screw itEDIT: proposed changes here https://github.com/marko-js/tags-api-preview/pull/29Consider specifying
@latest
:just assuming that
@latest
could help if someone somehow has outdated marko NOTE: primarily a suggestion for the Twitter post and/or blog type postsMore examples
regarding: https://github.com/marko-js/tags-api-preview TODO: mention using
npm init marko -- --template tags-api
command to create a new project TODO: point to https://github.com/marko-js/examples/tree/master/examples/tags-api-guide as wellregarding: https://dev.to/ryansolid/introducing-the-marko-tags-api-preview-37o4 TODO: cannot copy/paste code examples as they are all images... perhaps at least provide try online links like for initial count example... could perhaps be added to examples repo as a set of examples similar to the tags-api-guide set of examples TODO: mention using
npm init marko@latest -- --template tags-api
command to create a new project