Skip to content

Commit 80837fc

Browse files
mdellwegpedro-psb
authored andcommitted
Adjust some md examples and their source
1 parent 24a8ea2 commit 80837fc

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

src/pulp_docs/data/mkdocs.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: Pulp Project
2-
site_url: https://staging-docs.pulpproject.org/
2+
site_url: https://pulpproject.org/
33
repo_url: https://github.com/pulp/pulpcore
44
repo_name: pulp/pulpcore
55

@@ -29,13 +29,13 @@ theme:
2929
primary: custom
3030
accent: black
3131
toggle:
32-
icon: material/toggle-switch-off-outline
32+
icon: material/toggle-switch-off-outline
3333
name: Switch to dark mode
3434
- media: "(prefers-color-scheme: dark)"
35-
scheme: slate
35+
scheme: slate
3636
toggle:
3737
icon: material/toggle-switch
38-
name: Switch to light mode
38+
name: Switch to light mode
3939
hooks:
4040
- '../mkdocs_hooks.py'
4141
plugins:
@@ -51,7 +51,7 @@ plugins:
5151
- literate-nav:
5252
nav_file: _SUMMARY.md
5353
- mkdocstrings:
54-
handlers:
54+
handlers:
5555
python:
5656
options:
5757
show_source: false

staging_docs/dev/reference/markdown-cheatsheet.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ The basic syntax is:
6969
Ordering is enabled by `mkdocs-literate-nav`
7070
(learn more [here](https://oprypin.github.io/mkdocs-literate-nav/reference.html)).
7171

72-
The basic setup is having a a file in `{repo}/docs/{user}/{persona}/_SUMMARY.md`.
72+
The basic setup is having a file in `{repo}/docs/{persona}/{doc_type}/_SUMMARY.md`.
7373
In this file you should use the following syntax:
7474

75-
```markdown title="pulp_rpm/docs/user/guides/_SUMMARY.md"
75+
```markdown title="pulp_plugin/docs/user/guides/_SUMMARY.md"
7676
# Basic
7777
* [First list item](z-page.md)
7878
* [Second list item](m-page.md)
@@ -87,7 +87,7 @@ In this file you should use the following syntax:
8787
# Recursive Globs
8888
* [I want this first](some-page.md)
8989
* *.md
90-
* [This last and recurse this dir](other/)
90+
* [This last and recurse this dir](other/)
9191
```
9292

9393
### Codeblocks
@@ -111,6 +111,7 @@ Markdown syntax:
111111
serializer = mymodelserializer(data=data)
112112
serializer.is_valid(raise_exception=true)
113113
instance = serializer.create(serializer.validated_data)
114+
print(instance)
114115
```
115116
````
116117

@@ -125,11 +126,11 @@ The codeblock can also have a title, which is useful if its a file:
125126
Markdown syntax:
126127

127128
````
128-
```bash title="script.sh"
129+
```bash title="sample-title-here.sh"
129130
pulp file repository update --name myrepo --retained-versions 1
130131
```
131132
````
132-
133+
133134
### Admonitions
134135

135136
[See mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types)

0 commit comments

Comments
 (0)