Skip to content

README.md: mention commands to generate the bundle #93

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.

Sign up for GitHub

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

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

README.md: mention commands to generate the bundle #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ TOC is a library that will automatically generate a table of contents for your p
npm install import '@firstandthird/toc'
```

## Build locally

Within this Git repository, you may build using:

```sh
npm install
npm run build
```

The second command generates a `dist/toc.bundle.js` file that may be
included in HTML pages using e.g. `<script src="toc.bundle.js"></script>`.

## Usage

Import required scripts:
Expand Down