This project uses pnpm with workspaces. So pnpm should be installed.

This project has been generated from with a $ pnpm create vite command and selecting the vanilla-ts project.

Materialize has been added as a git submodule in packages folder and then defined as a pnpm workspace, to use it as a monorepo.

Typescript has been configured to treat all projects in /packages folder as typescript packages.

head, navbar and footer in all html pages has been defined using vite-plugin-handlebars.

git clone https://github.com/materializecss/materialize-docs.git
cd materialize-docs
git submodule init
git submodule update
pnpm install
pnpm dev

This is a very convenient way to work in materialize or docs because all changes in both projects are inmediately displayed in the browser.

Also browser debugging displays the files exactly as they are in the source.

Note: when a new page is selected it takes some time to render completely the page. This not happens in the build version.

• Pull the newest main branch from the core repository

pnpm build
pnpm preview

The docs should be kept in the core repo as markdown files for quick editing. This repo should then collect all the markdown files from the core repo and compile them into a collection of nice html files, The versions are managed in docs/version/ to keep different versions. The workflow was removed for now.

This has to be done after release process of the core repo and releasing on npm

• Pull newest package in packages/materialize (later pull version by tag)
• Update version string in src/public/info, src/getting-started.html, partials/navbar.html
• Run docs locally and check manually with pnpm dev & pnpm build
• run node release.js to create new version
• goto docs folder and run locally via npx http-server -c-1 -p 8080 and test in browser
• Make PR into main
• Spread news via social media channels