Tweak doc h1

This commit is contained in:
Brandon Keepers
2017-08-07 13:21:53 -05:00
parent bfe1a80bd6
commit 6ac0fd24c0
7 changed files with 8 additions and 9 deletions

View File

@@ -1,5 +1,5 @@
.markdown-body {
h1 { @include alt-h3; }
h1 { @include alt-h2; }
h2 { @include alt-h3; }
h3 { @include alt-h3; }

View File

@@ -2,7 +2,7 @@
next: docs/http.md
---
## Interacting with GitHub
# Interacting with GitHub
Probot uses [GitHub Apps](https://developer.github.com/apps/). An app is a first-class actor on GitHub, like a user (e.g. [@defunkt](https://github/defunkt)) or an organization (e.g. [@github](https://github.com/github)). The app is given access to a repository or repositories by being "installed" on a user or organization account and can perform actions through the API like [commenting on an issue](https://developer.github.com/v3/issues/comments/#create-a-comment) or [creating a status](https://developer.github.com/v3/repos/statuses/#create-a-status).

View File

@@ -2,9 +2,9 @@
next: docs/development.md
---
## Hello World
# Hello World
A plugin is just a [Node.js module](https://nodejs.org/api/modules.html) that exports a function:
A Probot plugin is just a [Node.js module](https://nodejs.org/api/modules.html) that exports a function:
```js
module.exports = robot => {

View File

@@ -2,8 +2,7 @@
next: docs/simulating-webhooks.md
---
## HTTP Routes
# HTTP Routes
Calling `robot.route('/my-plugin')` will return an [express](http://expressjs.com/) router that you can use to expose HTTP endpoints from your plugin.

View File

@@ -2,7 +2,7 @@
next: docs/deployment.md
---
### Pagination
# Pagination
Many GitHub API endpoints are paginated. The `github.paginate` method can be used to get each page of the results.

View File

@@ -2,7 +2,7 @@
next: docs/testing.md
---
## Simulating webhooks
# Simulating webhooks
As you are developing your plugin, you will likely want to test it by repeatedly trigging the same webhook. You can simulate a webhook being delivered by saving the payload to a file, and then calling `probot simulate` from the command line.

View File

@@ -2,7 +2,7 @@
next: docs/github-api.md
---
## Receiving Webhooks
# Receiving Webhooks
[GitHub webhooks](https://developer.github.com/webhooks/) are fired for almost every significant action that users take on GitHub, whether it's pushes to code, opening or closing issues, opening or merging pull requests, or commenting on a discussion.