From 6ac0fd24c0819804902fce2b3ff60a8cc467c143 Mon Sep 17 00:00:00 2001 From: Brandon Keepers Date: Mon, 7 Aug 2017 13:21:53 -0500 Subject: [PATCH] Tweak doc h1 --- _sass/markdown.scss | 2 +- docs/github-api.md | 2 +- docs/hello-world.md | 4 ++-- docs/http.md | 3 +-- docs/pagination.md | 2 +- docs/simulating-webhooks.md | 2 +- docs/webhooks.md | 2 +- 7 files changed, 8 insertions(+), 9 deletions(-) diff --git a/_sass/markdown.scss b/_sass/markdown.scss index 51011ff..904bc78 100644 --- a/_sass/markdown.scss +++ b/_sass/markdown.scss @@ -1,5 +1,5 @@ .markdown-body { - h1 { @include alt-h3; } + h1 { @include alt-h2; } h2 { @include alt-h3; } h3 { @include alt-h3; } diff --git a/docs/github-api.md b/docs/github-api.md index 45321ff..67a29cd 100644 --- a/docs/github-api.md +++ b/docs/github-api.md @@ -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). diff --git a/docs/hello-world.md b/docs/hello-world.md index b4f4587..69f5398 100644 --- a/docs/hello-world.md +++ b/docs/hello-world.md @@ -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 => { diff --git a/docs/http.md b/docs/http.md index e3c1972..1922a5e 100644 --- a/docs/http.md +++ b/docs/http.md @@ -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. diff --git a/docs/pagination.md b/docs/pagination.md index 14b3c29..556e256 100644 --- a/docs/pagination.md +++ b/docs/pagination.md @@ -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. diff --git a/docs/simulating-webhooks.md b/docs/simulating-webhooks.md index 3f7e3dc..091d40e 100644 --- a/docs/simulating-webhooks.md +++ b/docs/simulating-webhooks.md @@ -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. diff --git a/docs/webhooks.md b/docs/webhooks.md index 154cdcc..d79606d 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -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.