You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by pn...@apache.org on 2023/12/11 13:19:14 UTC

(flink) 06/06: [hotfix][docs] Make lvl 1 headers visible in the docs TOC

This is an automated email from the ASF dual-hosted git repository.

pnowojski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 589ea2e752495fd724bb85541e6566be907db0ba
Author: Piotr Nowojski <pi...@gmail.com>
AuthorDate: Thu Dec 7 11:01:33 2023 +0100

    [hotfix][docs] Make lvl 1 headers visible in the docs TOC
    
    https://github.com/apache/flink/pull/23845#discussion_r1417918412
    
    There are many pages that have more than one lvl 1 header.
    In that case, our current TOC doesn't make sense and is mostly
    unreadable, as by default TOC start from lvl 2 headers only.
    
    For example:
    docs/content/docs/deployment/config.md
---
 docs/config.toml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/config.toml b/docs/config.toml
index 8969a081bd5..3776b6f895d 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -100,6 +100,8 @@ pygmentsUseClasses = true
 [markup]
 [markup.goldmark.renderer]
   unsafe = true
+[markup.tableOfContents]
+  startLevel = 1
 
 [languages]
 [languages.en]