webdev-learning

Webdev Learning resources repository

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Write header ID in .mdx

yarn write-heading-ids --overwrite docs/**/* *.mdx

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy"

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

DocSearch using algolia

https://docsearch.algolia.com/docs/legacy/run-your-own/