@tomsd/md-book
v2.0.10
Published
It provides .js that displays the contents from the markdown document files on page
Readme
@tomsd/md-book
It provides a JS file for you who want to aggregate the markdown files in one page.
See https://md-book.netlify.app/ for details.
Installation
npm install @tomsd/md-bookInitialization
CLI creates an HTML file with --init option.
npx mdbook --init --directory path/to/directorySettings
Open the HTML file and edit it.
The markdown file paths are to be filled in the HTML file.
Serve
CLI provides the local server.
npx mdbook --serve --directory path/to/directoryPublish
The directory can be published, to be hosted by static site hosting services.
Testing
Unit and Browser Tests
npm run testE2E Tests with Visual Regression Testing
# Run E2E tests with VRT
npm run test:e2e
# Update baseline screenshots
npm run test:e2e:updateThe E2E tests include visual regression testing (VRT) using Playwright's screenshot comparison feature. Baseline screenshots are stored in test/e2e/__screenshots__/ and automatically compared during test runs.
