/single-spa.js.org

Primary LanguageHTML

single-spa.js.org

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

Getting started

Prerequisites

  1. Git
  2. Node: install version 8.4 or greater
  3. Yarn: See Yarn website for installation instructions
  4. A fork of the repo (for any contributions)
  5. A clone of the single-spa.js.org repo on your local machine

Installation

  1. git clone git@github.com:single-spa/single-spa.js.org.git
  2. cd single-spa.js.org/website to go into the website root
  3. yarn to install the website's npm dependencies

Running locally

  1. cd website then run yarn start to start the hot-reloading development server (powered by Docusaurus)
  2. open http://localhost:3000 to open the site in your favorite browser

Contributing

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

Create a branch

  1. git checkout master from any folder in your local single-spa.js.org repository
  2. git pull origin master to ensure you have the latest main code
  3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

  1. Save the files and check in the browser
  2. Changes to files in website/pages/en will hot-reload
  3. Changes to markdown files in docs will hot-reload
  4. Changes to siteConfig.js and sideBards.json will not hot-reload

Test the change

  1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

Push it

  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 single-spa.js.org repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. If possible, include screenshots of visual changes.