-
-
Notifications
You must be signed in to change notification settings - Fork 924
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
Conversation
Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2. - [Release notes](https://github.com/isaacs/minimatch/releases) - [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md) - [Commits](isaacs/minimatch@v3.0.4...v3.1.2) --- updated-dependencies: - dependency-name: minimatch dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]>
Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4. - [Release notes](https://github.com/caolan/async/releases) - [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md) - [Commits](caolan/async@v2.6.3...v2.6.4) --- updated-dependencies: - dependency-name: async dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Claudia Meadows <[email protected]>
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.
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.
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 updated the port used by the esbuild template, and the dev script should log the port to the console by default.
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.
Would be so great to have the webpack instructions gone, this looks great.
Been a while since I looked at this. I'll make a note to take a look today/this week to fix the formatting and update the templates. FWIW, I think any templates should probably be under the |
OK pushed up my changes/fixes, and also went ahead and updated the esbuild + rollup template repos. |
@dead-claudia does this need to target the new docs repo now? |
@JAForbes Yes. |
@kevinfiol Please recreate this against https://github.com/MithrilJS/docs |
Thanks @dead-claudia . Opened MithrilJS/docs#7 |
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
For some notes on why I went with esbuild as the "default":
How Has This Been Tested?
Ran
npm run build:docs
locally and reviewed built documentationTypes of changes
Checklist:
docs/changelog.md