Skip to content

Commit 08b5ca3

Browse files
committed
Adjust html anchor to work with the fixed header
1 parent 6b00e32 commit 08b5ca3

40 files changed

Lines changed: 76 additions & 33 deletions

docs/assets/default.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ a.headerlink {
22
display: none !important;
33
}
44

5+
h2 {
6+
margin-top: -120px;
7+
padding-top: 120px;
8+
}
9+
510
.section-title {
611
font-size: 2rem;
712
line-height: 2.5rem;

docs/guides/app-distribution.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ All your app needs to do to properly handle OAuth Flow are:
3030
* Provide the endpoints to navigate installers for the completion/cancellation of the installation flow
3131
* The URLs are usually somewhere else but Bolt has simple functionality to serve them
3232

33+
---
3334
## Examples
3435

3536
Here is a Bolt app demonstrating how to implement OAuth flow. As the OAuth flow handling features are unnecessary for many custom apps, those are disabled by default. **App** instances need to explicitly call `asOAuthApp(true)` to turn on them.

docs/guides/app-home.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ All your app needs to do to provide Home tabs to your app users are:
3131

3232
Most commonly, [`"app_home_opened"`](https://api.slack.com/events/app_home_opened) events would be used as the trigger to call the [**views.publish**](https://api.slack.com/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
3333

34+
---
3435
## Examples
3536

3637
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.

docs/guides/audit-logs-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The Audit Logs API can be used by security information and event management (SIE
1212

1313
Follow the instructions in [the API document](https://api.slack.com/docs/audit-logs-api) to get a valid token for using Audit Logs API. Your Slack app for Audit Logs API needs to be installed on the Enterprise Grid Organization, not an individual workspace within the organization.
1414

15+
---
1516
## Call Audit Logs API in Java
1617

1718
It's straight-forward to call Audit Logs API using **slack-api-client** library.

docs/guides/bolt-basics.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ lang: en
1010

1111
This guide covers all the basics of Bolt app development. If you're not yet familiar with Slack app development in general, we recommend reading [An introduction to Slack apps](https://api.slack.com/start/overview).
1212

13+
---
1314
## Start with the App class
1415

1516
The **App** class is a place to write only essential parts of your Slack app without being bothered by trifles.
@@ -25,6 +26,7 @@ app.command("/echo", (req, ctx) -> {
2526
});
2627
```
2728

29+
---
2830
## Dispatching Events
2931

3032
Here is the list of the available methods to dispatch events.
@@ -45,6 +47,7 @@ Here is the list of the available methods to dispatch events.
4547
|**app.dialogCancellation**|callback_id **String** \| **Pattern**|**Dialogs**: Responds to the events where users close dialogs by clicking Cancel buttons.|
4648
|**app.attachmentAction**|callback_id: **String** \| **Pattern**|**Legacy Messaging**: Responds to user actions in **attachments**. These events can be triggered in only messages.|
4749

50+
---
4851
## Development Guides by Feature
4952

5053
On these guide pages, you'll find a more concrete example code for each.
@@ -57,6 +60,7 @@ On these guide pages, you'll find a more concrete example code for each.
5760
* [**Events API**]({{ site.url | append: site.baseurl }}/guides/events-api)
5861
* [**App Distribution (OAuth Flow)**]({{ site.url | append: site.baseurl }}/guides/app-distribution)
5962

63+
---
6064
## Acknowledge Incoming Requests
6165

6266
Actions, commands, and options events must always be acknowledged using the `ack()` method. All such utility methods are available as the instance methods of a **Context** object.
@@ -102,6 +106,7 @@ app.command("/ping", (req, ctx) -> {
102106
});
103107
```
104108

109+
---
105110
## Respond to User Actions
106111

107112
Are you already familiar with `response_url`? If not, we recommend reading [this guide](https://api.slack.com/interactivity/handling#message_responses) first.
@@ -123,6 +128,7 @@ app.command("/hello", (req, ctx) -> {
123128
});
124129
```
125130

131+
---
126132
## Use Web APIs / Reply using say utility
127133

128134
When you need to call some Slack Web APIs in Bolt apps, use `ctx.client()` for it. The **MethodsClient** created by the method already holds a valid bot token. So, you don't need to give a token to it. Just calling a method with parameters as below works for you.
@@ -176,6 +182,7 @@ app.command("/my-search", (req, ctx) -> {
176182
});
177183
```
178184

185+
---
179186
## Use Logger
180187

181188
You can access [SLF4J](http://www.slf4j.org/) logger in **Context** objects.
@@ -204,6 +211,7 @@ If you use the [**ch.qos.logback:logback-classic**](https://search.maven.org/art
204211
</configuration>
205212
```
206213

214+
---
207215
## Middleware
208216

209217
Bolt offers chaining middleware supports. You can customize **App** behavior by weaving a kind of filter to all events.
@@ -264,10 +272,12 @@ A set of the built-in middleware precedes your custom middleware. So, if the app
264272

265273
The most common would be the case where a request has been denied by **RequestVerification** middleware. After the denial, any middleware won't be executed, so that the above middleware also doesn't work for the case.
266274

275+
---
267276
## Supported Web Frameworks
268277

269278
Refer to [this page]({{ site.url | append: site.baseurl }}/guides/supported-web-frameworks) for more details.
270279

280+
---
271281
## Deployments
272282

273283
[We're planning](https://github.com/slackapi/java-slack-sdk/issues/348) to have some guide documents for deployments.

docs/guides/composing-messages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This section shows how to build Slack messages using **slack-api-client** librar
1010

1111
Also, before jumping into Java code, we recommend developing an understand of composing Slack messages. [Read the API documentation](https://api.slack.com/messaging/composing) for more information.
1212

13+
---
1314
## Text Formatting
1415

1516
Composing a text message is the simplest way to post a message to Slack conversations.
@@ -32,6 +33,7 @@ ChatPostMessageResponse response = slack.methods(token).chatPostMessage(req -> r
3233

3334
As you see, using `text` is fairly simple. The only thing to know is to give a string value with a valid format. Consult [Basic formatting with `mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) for understanding the markup language.
3435

36+
---
3537
## Building Blocks for Rich Message Layouts
3638

3739
[Block Kit](https://api.slack.com/block-kit) is a UI framework for Slack apps that offers a balance of control and flexibility when building experiences in messages and other [surfaces](https://api.slack.com/surfaces).

docs/guides/events-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ All you need to do to handle Events API requests are:
3131

3232
Your app has to respond to the request within 3 seconds by `ack()` method. Otherwise, the Slack Platform may retry after a while.
3333

34+
---
3435
## Examples
3536

3637
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.

docs/guides/getting-started-with-bolt.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ This guide explains how to start your first-ever Bolt app.
2525
If you're not yet familiar with Slack app development in general, we recommend reading [An introduction to Slack apps](https://api.slack.com/start/overview).
2626

2727
---
28-
2928
## Project Setup
3029

3130
Let's start building a Slack app with Bolt! This guide shows how to set up a Bolt project with Maven, and Gradle.
@@ -70,7 +69,6 @@ dependencies {
7069
```
7170

7271
---
73-
7472
## Run Your Bolt App in 3 Minutes
7573

7674
### Use **bolt-jetty**
@@ -230,7 +228,6 @@ public class SlackAppController extends SlackAppServlet {
230228
Check [the detailed guide here]({{ site.url | append: site.baseurl }}/guides/supported-web-frameworks) for further information.
231229

232230
---
233-
234231
## Getting Started in Kotlin
235232

236233
For code simplicity, [Kotlin](https://kotlinlang.org/) language would be a great option for writing Bolt apps. In this section, you'll learn how to set up a Kotlin project for Bolt apps.
@@ -308,6 +305,7 @@ From here, all you need to do is write code and restart the app. Enjoy Bolt app
308305

309306
**Pro tip**: We strongly recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/) here even if you don't prefer using IDEs. The IDE is the smoothest way to try Kotlin application development.
310307

308+
---
311309
## Next Steps
312310

313311
Read the [Bolt Basics]({{ site.url | append: site.baseurl }}/guides/bolt-basics) for further information.

docs/guides/incoming-webhooks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ To enable this feature, visit the [Slack App configuration page](http://api.slac
1414

1515
Then, install the app to your development workspace. Each time your app is installed, a new Webhook URL will be generated.
1616

17+
---
1718
## How To Use
1819

1920
Here is a **curl** command example demonstrating how to send a message via an Incoming Webhooks URL.

docs/guides/interactive-components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ All your app needs to do to handle Slack requests by user interactions are:
2929

3030
Your app has to respond to the request within 3 seconds by `ack()` method. Otherwise, the user will see the timeout error on Slack. For some of the requests including external selects, having valid parameters to the method may be required.
3131

32+
---
3233
## Examples
3334

3435
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.

0 commit comments

Comments
 (0)