fix: replace markdown-toc with remark (#11)

same rational as
mnahkies/openapi-code-generator#377

Author: mnahkies

README.md

@@ -9,32 +9,30 @@ also caution that the SPDX files produced by Github seem a bit rough around the
 This project is very early stage - it's pretty rough around the edges, has no tests, and is
 limited in features. Expect a bunch of breaking changes as I learn more about the world of processing SBOMs.
 
-<!-- toc -->
+## Contents
 
-- [Features](#features)
-- [Future](#future)
-- [Running it](#running-it)
-- [Screenshots](#screenshots)
-- [Architecture / Notes](#architecture--notes)
-- [Acknowledgements / References](#acknowledgements--references)
-
-<!-- tocstop -->
+* [Features](#features)
+* [Future](#future)
+* [Running it](#running-it)
+* [Screenshots](#screenshots)
+* [Architecture / Notes](#architecture--notes)
+* [Acknowledgements / References](#acknowledgements--references)
 
 ## Features
 
-- Crawl Github repositories extracting SBOM's using a PAT (Github Personal Access Token)
-- Fills in gaps for `npm` packages by reading metadata from the NPM Registry directly
-- Render back summary and detail views, including risk categories
+* Crawl Github repositories extracting SBOM's using a PAT (Github Personal Access Token)
+* Fills in gaps for `npm` packages by reading metadata from the NPM Registry directly
+* Render back summary and detail views, including risk categories
 
 ## Future
 
-- More filtering, sorting, etc options
-- Export to CSV / spreadsheet report
-- Allow upload of a SPDX file directly rather than crawling Github
-- Allow overriding data, eg: correct a license
-- Pull in CVE alerts
-- Tidy up the API, it's a bit haphazard right now
-- Add tests
+* More filtering, sorting, etc options
+* Export to CSV / spreadsheet report
+* Allow upload of a SPDX file directly rather than crawling Github
+* Allow overriding data, eg: correct a license
+* Pull in CVE alerts
+* Tidy up the API, it's a bit haphazard right now
+* Add tests
 
 ## Running it
 
@@ -47,7 +45,7 @@ cp .env.example .env # modify settings as needed
 pnpm run dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) to use the application.
+Open <http://localhost:3000> to use the application.
 Data will be written to the sqlite db specified by `DB_PATH`.
 
 ## Screenshots
@@ -58,17 +56,17 @@ Data will be written to the sqlite db specified by `DB_PATH`.
 
 ## Architecture / Notes
 
-- Implemented as a single [NextJS](https://nextjs.org/) application.
-- [mui](https://mui.com/) is used as the component library
-- [sqlite](https://sqlite.org/) is used as the database for data persistence
-- Database migrations are generated/managed by [atlas](https://atlasgo.io/), see [migrate.sh](./bin/migrate.sh) / [migrate-generate.sh](./bin/migrate-generate.sh)
-- Database schema is introspected to produce [zod](https://zod.dev/) schemas for each table, using a script I haven't published anywhere yet
-- An basic [openapi.yaml](./openapi.yaml) specification is used to generate most of the client/server glue using [experimental nextjs template](https://github.com/mnahkies/openapi-code-generator/pull/152)
-- [mnahkies/openapi-code-generator](https://github.com/mnahkies/openapi-code-generator) is also used to generate the Github client
-- License data was scraped from [dependency-track](https://github.com/DependencyTrack/dependency-track)
+* Implemented as a single [NextJS](https://nextjs.org/) application.
+* [mui](https://mui.com/) is used as the component library
+* [sqlite](https://sqlite.org/) is used as the database for data persistence
+* Database migrations are generated/managed by [atlas](https://atlasgo.io/), see [migrate.sh](./bin/migrate.sh) / [migrate-generate.sh](./bin/migrate-generate.sh)
+* Database schema is introspected to produce [zod](https://zod.dev/) schemas for each table, using a script I haven't published anywhere yet
+* An basic [openapi.yaml](./openapi.yaml) specification is used to generate most of the client/server glue using [experimental nextjs template](https://github.com/mnahkies/openapi-code-generator/pull/152)
+* [mnahkies/openapi-code-generator](https://github.com/mnahkies/openapi-code-generator) is also used to generate the Github client
+* License data was scraped from [dependency-track](https://github.com/DependencyTrack/dependency-track)
 
 ## Acknowledgements / References
 
-- [dependency-track](https://github.com/DependencyTrack/dependency-track)
-- [spdx-spec](https://spdx.github.io/spdx-spec/v2.3/)
-- [github docs](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)
+* [dependency-track](https://github.com/DependencyTrack/dependency-track)
+* [spdx-spec](https://spdx.github.io/spdx-spec/v2.3/)
+* [github docs](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)

package.json

@@ -11,7 +11,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "biome lint --write .",
     "format": "biome check --write .",
-    "docs:generate": "pnpm exec markdown-toc -i --bullets=- ./README.md",
+    "docs:generate": "node ./bin/generate-toc.mjs",
     "migrate": "dotenvx run -- ./bin/migrate.sh",
     "migrate-generate": "dotenvx run -- ./bin/migrate-generate.sh",
     "migrate-rehash": "dotenvx run -- atlas migrate hash --dir 'file://migrations",