Repository files navigation

This project uses pnpm with workspaces. So pnpmshould 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 apnpm 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 usingvite-plugin-handlebars.

git clone https://github.com/materializecss/materialize-docs.gitcd materialize-docsgit submodule initgit submodule updatepnpm installpnpm 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 thecore repository

pnpm buildpnpm preview

The docs should be kept in the core repo as markdown files for quick editing. This repo should thencollect 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 inpackages/materialize (later pull version by tag)
• Update version string insrc/public/info,src/getting-started.html,partials/navbar.html
• Run docs locally and check manually withpnpm dev &pnpm build
• runnode release.js to create new version
• goto docs folder and run locally vianpx http-server -c-1 -p 8080 and test in browser
• Make PR into main
• Spread news via social media channels