This repo contains the source code and documentation powering single-spa.js.org. Powered by Docusaurus.
- git
- node >=16.14
- your fork of this repo
git clone git@github.com:<your-fork-of>/single-spa.js.org.git
cd single-spa.js.org
to go into the website rootnpm i
to install dependencies
- run
npm start
to start the hot-reloading development server open http://localhost:3000
to open the site in your favorite browser- Changes to files in
src/
will hot-reload - Changes to markdown files in
docs/
will hot-reload - Changes to
docusaurus.config.js
andsidebars.json
will not hot-reload
- Changes to files in
Want to help improve the single-spa.js.org
website? Checkout the steps below to learn how.
git pull origin master
to ensure you have the latest main codegit switch -c descriptive-branch-name
Test visual changes using any number of latest versions of common browsers, on both desktop and mobile
git add . && git commit -m "My message"
(replacingMy message
with a commit message, such asFixed header logo
) to stage and commit your changesgit push my-fork-name the-name-of-my-branch
- Go to the upstream single-spa.js.org repo and you should see recently pushed branches.
- Create a pull request describing the changes
- If possible, include screenshots of visual changes.
- (Optional) Post your PR in the #maintainers channel of the Slack workspace