You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -452,11 +452,11 @@ For more details and configuration options, see the [Mermaid usage docs](https:/
452
452
453
453
The easiest way to test changes to ExDoc is to locally rebuild the app and its own documentation:
454
454
455
-
1. Run `mix setup` to install all dependencies.
456
-
2. Run `mix build` to generate the docs. This is a custom alias that will build assets, recompile ExDoc, and output fresh docs into the `doc/` directory.
457
-
3. If working on the assets, you may wish to run the assets build script in watch mode: `npm run --prefix assets build:watch`.
458
-
4. Run `mix lint` to check if the Elixir and JavaScript files are properly formatted. You can run `mix fix` to let the JavaScript linter and Elixir formatter fix the code automatically before submitting your pull request.
459
-
5. Please do not add the files generated in the `formatters/` directory to your commits. These will be handled as necessary by the repository maintainers.
455
+
1. Run `mix setup` to install all dependencies
456
+
2. Run `mix build` to generate the docsand open up the generated `doc/index.html`
457
+
3. (optional) Run `npm run --prefix assets build:watch` if working on assets for automatic recompilation
458
+
4. Run `mix lint` to check linting and formatting (and `mix fix` to automatically fix it)
459
+
5. (important) Do not add the files in the `formatters/` directory to your commits, those will be handled by the maintainers
460
460
461
461
See the README in the `assets/` directory for more information on working on the assets.
0 commit comments