-
-
Notifications
You must be signed in to change notification settings - Fork 927
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
Update installation docs to use templates + esbuild instructions #2827
base: next
Are you sure you want to change the base?
Conversation
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.
I went through your instructions by all doing it by myself. Everything worked as expected. Nice and consise.
### Quick start with Webpack | ||
### Create a project locally | ||
|
||
You can use one of several existing Mithril starter templates such as |
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.
You should use Mithril.js here.
Maybe you could fix the same on top of page in the second paragraph, too. Where it reads: "If you would like to try out mithril without setting..."
npm install | ||
|
||
# Build the app and watch for changes | ||
npm run dev |
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.
} | ||
``` | ||
|
||
Optionally, if you'd like to use JSX, you can use the `--jsx-factory` and `--jsx-fragment` flags with esbuild. |
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.
Removes wordy "Step by Step" section of the installation page, as well instructions on using budo, and adds Mithril starter templates that are easy to clone. Also rewrites
Quick start
section to use esbuild instead of Webpack.Description
Remove instances of using
npm install
with the--save
flag as that flag is no longer necessary since npm v5.Remove Step by step section
Remove Alternate ways to use Mithril.js section
Rewrite Quick start with Webpack to use esbuild instead.
Add "Create a project locally" section that lists three different templates a user can get started with:
Review the rendered markdown here.
Motivation and Context
How Has This Been Tested?
Ran
npm run build:docs
locally and reviewed built documentationTypes of changes
Checklist:
docs/changelog.md