diff --git a/README.md b/README.md index 1d456be..a25733e 100644 --- a/README.md +++ b/README.md @@ -157,8 +157,7 @@ Fork, clone, then instead of `npm install` run: npm run install:all ``` -> **Note** -> +> [!NOTE]\ > This will install dependencies for the package itself, and also for **docs** and **benchmarks** packages. This is due to limitations of the current repository setup and needed to avoid problems with eslint that runs on pre-commit hook. This project follows [the conventional commits spec][cc-spec] and uses [a slightly modified commitlint preset][commitlint-preset] for automatic linting commits and generating changelog. @@ -173,9 +172,9 @@ This project follows [the conventional commits spec][cc-spec] and uses [a slight [rd]: https://en.wikipedia.org/wiki/Recursive_descent_parser [parser-combinator]: https://en.wikipedia.org/wiki/Parser_combinator [cfg]: https://en.wikipedia.org/wiki/Context-free_grammar -[docs]: https://sigma.vm.codes +[docs]: https://sigma.nrsk.dev [docs-source]: ./docs [bench]: ./benchmarks [skypack]: https://skypack.dev -[cc-spec]: https://www.conventionalcommits.org/en/v1.0.0/#summary +[cc-spec]: https://conventionalcommits.org/en/v1.0.0/#summary [commitlint-preset]: https://github.com/norskeld/config-conventional diff --git a/docs/README.md b/docs/README.md index 9b4e763..2634998 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ This is the documentation site for [@nrsk/sigma] built with [VitePress]. ## Development -The documentation is hosted on Vercel, so changes will be published automatically. +The documentation is hosted on CloudFlare Pages, so changes will be published automatically. ```bash npm run build # Build for production diff --git a/docs/vercel.json b/docs/vercel.json deleted file mode 100644 index bd6fd8f..0000000 --- a/docs/vercel.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "cleanUrls": true -}