Caution

This repository is no longer maintained.

The documentation below is provided for historical reference only.

XMTP Website Starter Kit

This web starter is built using Docusaurus 2 and Tailwind CSS.

This repo will serve as the base for new websites to be built at xmtp.com (for XMTP Labs) and xmtp.org (for XMTP). Any changes that would need to happen on both sites should be made here, and upstream changes pulled in each individual repo.

What is different than base Docusaurus?

Files added

website # Root directory of your site
└── src
    └── css
        ├── tailwind.css // global changes to be made here, replaces custom.css
└── tailwind.config.js

Plugins added

• Tailwind CSS
• Docusaurus
  • plugin-google-gtag
  • theme-search-algolia

Components added

• …

Installation

npm install

Local Development

npm run 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

npm run build

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

Deployment

See the official project documentation on Deployment.