Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the Papercup docs with GitBook! #9

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,2 @@
# Website
# introduction

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation

```console
npm install
```

## Local Development

```console
npm 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

```console
npm build
```

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

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true npm 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.
26 changes: 26 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Table of contents

* [Introduction](README.md)
* [About](introduction/about.md)
* [FAQs](introduction/faqs.md)
* [Getting Started](getting-started/README.md)
* [Setting up chat](getting-started/chat.md)
* [Development](getting-started/development.md)
* [Replying from Mattermost](getting-started/reply-from-mattermost.md)
* [Replying from Slack](getting-started/reply-from-slack.md)
* [Replying via SMS](getting-started/reply-via-sms.md)
* [Webhooks](webhooks/README.md)
* [Webhook events](webhooks/events.md)
* [Subscribing to events](webhooks/subscribing.md)
* [API Reference](api-reference/README.md)
* [API endpoints](api-reference/api-endpoints.md)
* [Getting an API key](api-reference/api-keys.md)
* [Functions (beta)](api-reference/functions.md)
* [Deploying](deploying/README.md)
* [Deploy on AWS](deploying/aws.md)
* [Deploy with Heroku](deploying/heroku.md)
* [Setting up Slack](deploying/slack.md)
* [Chat](chat/README.md)
* [Configuration](chat/configuration.md)
* [Contributing](contributing.md)
* [Support](support.md)
2 changes: 2 additions & 0 deletions api-reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# api-reference

Loading