single-spa.js.org

This repo contains the source code and documentation powering single-spa.js.org. Powered by Docusaurus.

Prerequisites

1. git
2. node >=16.14
3. your fork of this repo

Installation

1. git clone [email protected]:<your-fork-of>/single-spa.js.org.git
2. cd single-spa.js.org to go into the website root
3. npm i to install dependencies

Running locally

1. run npm start to start the hot-reloading development server
2. 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 and sidebars.json will not hot-reload

Contributing

Want to help improve the single-spa.js.org website? Checkout the steps below to learn how.

Create a branch

1. git pull origin master to ensure you have the latest main code
2. git switch -c descriptive-branch-name

Test visual changes using any number of latest versions of common browsers, on both desktop and mobile

Contribute!

1. git add . && git commit -m "My message" (replacing My message with a commit message, such as Fixed header logo) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. Go to the upstream single-spa.js.org repo and you should see recently pushed branches.
4. Create a pull request describing the changes
   • If possible, include screenshots of visual changes.
5. (Optional) Post your PR in the #maintainers channel of the Slack workspace