> For the complete documentation index, see [llms.txt](https://mhy.js.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mhy.js.org/tools/configs/mhy.md).

# mhy

`mhy` is being built using `mhy` :) Just like `npm` is a package on `npm`. It's core configuration values are stored using `mhy` also.

```bash
# Print config to console
mhy config mhy
```

## Options

### `defaultIndexHtml`

The `index.html` file to load when using `webpack`.

Default is provided by `mhy`: `resources/index.html`

> You can use your own by putting it to your `src` folder. Not necessary to overwrite this value.

### `srcFolder`

Folder to your source files from you project root.

Default: `src`

### `defaultIgnoreList`

An array including the list of filenames needed to be excluded in general (like cache folders, log files, etc). Both `gitignore` and `npmignore` configs are extending this list.

> Please see source file for details.

### `defaultAliases`

Aliases provided for `SWC` and `TypeScript` imports.

Default: `{ '@': 'src' }`

With the default solution you can have aliases to all the folder in `src`.

Example: `import Foo from '@/components/foo'`

> Please note that previously aliases were provided for certain folders as `@components`. These are being **DEPRECATED** and should not be used. The new way is more flexible and avoids collision with NPM namespaces.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mhy.js.org/tools/configs/mhy.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.