Skip to content
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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

kevinfiol
Copy link
Contributor

@kevinfiol kevinfiol commented Apr 6, 2023

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

Review the rendered markdown here.

Motivation and Context

  • Why is this change required? What problem does it solve?
    • Simplifies installation documentation
    • Moves the documentation to use newer, more up-to-date and performant tools. Webpack has a much larger dependency graph while being far less performant than esbuild, rollup, or Vite.

How Has This Been Tested?

Ran npm run build:docs locally and reviewed built documentation

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated docs/changelog.md

@kevinfiol kevinfiol changed the title Update installation docs to use templates + esbuild Update installation docs to use templates + esbuild instructions Apr 6, 2023
Copy link
Contributor

@tbreuss tbreuss left a 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
Copy link
Contributor

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
Copy link
Contributor

@tbreuss tbreuss May 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like port 8080 is the default. Maybe a hint could be helpful how to solve this, if port 8080 is already in use (in my case traefik).

port-8080-already-in-use

}
```

Optionally, if you'd like to use JSX, you can use the `--jsx-factory` and `--jsx-fragment` flags with esbuild.
Copy link
Contributor

@tbreuss tbreuss May 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation doesn't look so nice.

indentation

Maybe that could be optimized? For example, so that everything is indented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants