README.md

deepstream.io website

🚀 Quickest start without downloading

1. Go to the document you want to edit on deepstreamio.github.io (click on the edit link on each page)
2. Edit the file
3. Commit

🚀 Quick start for downloading

This website is built using Docusaurus 2, a modern static website generator.

1. git clone
2. npm i
3. npm start
4. Edit as you see fit
5. Commit
6. Raise PR

A quick look at the top-level files and directories you should care about:

.
├── docs
├── blog
├── static
└──src

1. /docs: This directory contains all the content markdown content on the website and is organized into the different routes on the application. Adding a document in most cases will automatically add it to the index pages and the navigation menus.

2. /blog: This directory contains blog posts.

3. /static: This directory contains all the images and static assets.

4. /src: This directory contains all the react components and styles to render the page. If you feel a component can be displayed better this is the place to be!