Skip to content

Commit 017b6c7

Browse files
authored
fix(doc): Disable markup.highlight.guessSyntax + enable mermaid (#10509)
* enable mermaid, disable guessSyntax * Set languages
1 parent 3c8eb03 commit 017b6c7

7 files changed

Lines changed: 18 additions & 10 deletions

File tree

docs/config.dev.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ weight = 1
8585
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
8686
style = "dracula"
8787
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
88-
guessSyntax = "true"
88+
# Do not uncomment otherwise it breaks mermaid
89+
# guessSyntax = "true"
8990

9091
# Everything below this are Site Params
9192

@@ -198,3 +199,6 @@ enable = false
198199
url = "https://owasp.slack.com/archives/C014H3ZV9U6"
199200
icon = "fab fa-slack"
200201
desc = "Chat with other project developers"
202+
203+
[params.mermaid]
204+
enable = true

docs/config.master.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,8 @@ weight = 1
8585
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
8686
style = "dracula"
8787
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
88-
guessSyntax = "true"
88+
# Do not uncomment otherwise it breaks mermaid
89+
# guessSyntax = "true"
8990

9091
# Everything below this are Site Params
9192

@@ -198,3 +199,6 @@ enable = false
198199
url = "https://owasp.slack.com/archives/C014H3ZV9U6"
199200
icon = "fab fa-slack"
200201
desc = "Chat with other project developers"
202+
203+
[params.mermaid]
204+
enable = true

docs/content/en/integrations/ldap-authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Please check for the latest version of these requirements at the time of impleme
4141

4242
Otherwise add the following to requirements.txt:
4343

44-
```
44+
```python
4545
python-ldap==3.4.2
4646
django-auth-ldap==4.1.0
4747
```
@@ -119,7 +119,7 @@ Read the docs for Django Authentication with LDAP here: https://django-auth-ldap
119119
In order to pass the variables to the settings.dist.py file via docker, it's a good idea to add these to the docker-compose file.
120120

121121
You can do this by adding the following variables to the environment section for the uwsgi image:
122-
```
122+
```yaml
123123
DD_LDAP_SERVER_URI: "${DD_LDAP_SERVER_URI:-ldap://ldap.example.com}"
124124
DD_LDAP_BIND_DN: "${DD_LDAP_BIND_DN:-}"
125125
DD_LDAP_BIND_PASSWORD: "${DD_LDAP_BIND_PASSWORD:-}"

docs/content/en/integrations/parsers/file/fortify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ per category. To get all issues, copy the [DefaultReportDefinitionAllIssues.xml]
2020

2121
Once this is complete, you can run the following command on your .fpr file to generate the
2222
required XML:
23-
```
23+
```bash
2424
./path/to/ReportGenerator -format xml -f /path/to/output.xml -source /path/to/downloaded/artifact.fpr -template DefaultReportDefinitionAllIssues.xml
2525
```

docs/content/en/integrations/parsers/file/veracode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Veracode reports can be ingested in either XML or JSON Format
1414
- Requires slight modification of the response returned from the API
1515
- Exmample of a request being: `url <endpoint> | jq "{findings}"`
1616
- Desired Format:
17-
```
17+
```json
1818
{
1919
"findings": [
2020
{
@@ -28,7 +28,7 @@ Veracode reports can be ingested in either XML or JSON Format
2828
- This response can be saved directly to a file and uploaded
2929
- Not as ideal for crafting a refined report consisting of multiple requests
3030
- Desired Format:
31-
```
31+
```json
3232
{
3333
"_embedded": {
3434
"findings": [

docs/content/en/integrations/social-authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ Edit the settings (see [Configuration]({{< ref "/getting_started/configuration"
312312

313313
or, alternatively, for helm configuration, add this to the `extraConfig` section:
314314

315-
```
315+
```yaml
316316
DD_SESSION_COOKIE_SECURE: 'True'
317317
DD_CSRF_COOKIE_SECURE: 'True'
318318
DD_SECURE_SSL_REDIRECT: 'True'
@@ -453,7 +453,7 @@ Some Identity Providers are able to send list of groups to which should user bel
453453

454454
You can bypass the login form if you are only using SSO/Social authentication for login in by enabling these two environment variables:
455455

456-
```
456+
```yaml
457457
DD_SOCIAL_LOGIN_AUTO_REDIRECT: "true"
458458
DD_SOCIAL_AUTH_SHOW_LOGIN_FORM: "false"
459459
```

docs/content/en/usage/productgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Note that the following abbreviations were used:
2727
- med: amount of medium findings within the product
2828
- low: amount of low findings within the product
2929

30-
```
30+
```python
3131
health=100
3232
if crit > 0:
3333
health = 40

0 commit comments

Comments
 (0)