Skip to content
Draft
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
64 changes: 64 additions & 0 deletions design-docs/ci/.rumdl.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

# Markdown lint and format settings for the CI design docs.
# Based on rumdl's own config (github.com/rvben/rumdl/.rumdl.toml).
# Check: rumdl check -c design-docs/ci/.rumdl.toml design-docs/ci
# Format: rumdl fmt -c design-docs/ci/.rumdl.toml design-docs/ci

[global]
# Cache in build/ next to this file; build/ is git-ignored, so RAT and jj skip it.
cache-dir = "build/rumdl_cache"
# MD041: the Apache license header is an HTML comment before the title.
disable = ["MD041"]

# Wrap prose at 100 columns; `rumdl fmt` reflows paragraphs.
[MD013]
line-length = 100
code-blocks = true
tables = false
headings = true
reflow = true

# Align table columns; a table wider than 100 columns falls back to compact.
[MD060]
enabled = true
style = "aligned"
max-width = 100

[MD055]
style = "leading_and_trailing"

[MD029]
style = "ordered"

[MD046]
style = "fenced"

[MD048]
style = "backtick"

[MD049]
style = "asterisk"

[MD050]
style = "asterisk"

[MD051]
anchor-style = "github"
Loading
Loading