7cc5c4f330d47060/tiktok-sparo
1
0
Fork 0
mirror of https://github.com/tiktok/sparo.git synced 2024-11-23 15:48:16 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
tiktok-sparo/apps/website
History
Pete Gonzalez 4642442a95 Add CLI docs
2024-03-01 00:19:27 -08:00
..
docs Add CLI docs 2024-03-01 00:19:27 -08:00
src Improve website logo appearance in dark mode 2024-02-26 22:33:20 -08:00
static Improve website logo appearance in dark mode 2024-02-26 22:33:20 -08:00
babel.config.js npx create-docusaurus@latest website classic 2024-02-21 22:17:23 -08:00
build.js Fix an issue where the website project did not get built by CI 2024-02-23 15:34:27 -08:00
docusaurus.config.js Add ThemedImage to control logo color in dark mode 2024-02-26 22:39:53 -08:00
package.json Add dependency needed for type checking 2024-02-26 22:36:09 -08:00
README.md Enable site search 2024-02-26 21:27:10 -08:00
sidebars.js Add CLI docs 2024-03-01 00:19:27 -08:00

README.md

Website

This is the Docusaurus project for the Sparo website.

Development

  1. Install the monorepo dependencies using RushJS:

    rush install
rush build

  2. Launch the local development server:

    cd apps/website
rushx 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.

Site search

Because this site is relatively small, searching is performed client-side using the docusaurus-lunr-search plugin based on Lunr.js.

Notes:

  • Site search is broken when using the localhost debug server (rushx start), but it works correctly for real deployments (rushx deploy)
  • @algolia/client-search is included in package.json dependencies only because @docusaurus/preset-classic includes it as a peer dependency.

Deployment

  1. If you will manually copy the files to a server, you can build the apps/sparo/build folder like this:

    cd apps/website
rushx build

  2. To automatically deploy to GitHub Pages (as an administrator):

    # If you are using HTTPS authentication for GitHub:
cd apps/website
GIT_USER=<Your GitHub username> rushx deploy

    # If you are using SSH authentication for GitHub:
USE_SSH=true rushx deploy

See also