README.md

Earthstar Website

This is the documentation website for Earthstar. You can also just read the Markdown documents here on GitHub - look in the docs filder.

This is built with Docusaurus 2.

To add new pages

1. Add markdown files in the docs folder.
2. Update the sidebars.js file to include your new file.

Tips for formatting your markdown

Don't use h1 (#), start at h2 (##). The title from the frontmatter will effectively be your h1.

Your markdown file should start with a "frontmatter" which sets the page title in the sidebar and on the page itself. The markdown filename is used as the URL for your page so avoid special characters.

Frontmatter example:

---
title: How To Do Things
---

## Part 1

Blah blah blah...

Docusaurus Frontmatter documentation

Color theme

/src/css/custom.css

https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

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

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.