Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix examples for paths relative to the project root #186

Merged
merged 6 commits into from
Dec 20, 2023
Merged

Fix examples for paths relative to the project root #186

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f859d94
DOC: fix the example for paths relative to the project root
MarcBresson Dec 1, 2023
bb3fdc9
DOC: update relative folder statement to mention the mkdocs option 'd…
MarcBresson Dec 20, 2023
785d8fc
Changes in format to not break README translations
mondeja Dec 20, 2023
e2dc138
Fix error in translations
mondeja Dec 20, 2023
a40d84e
Use explicit relative paths
mondeja Dec 20, 2023
d30a241
Use code format for value
mondeja Dec 20, 2023
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Paths of included files can be either:
- Local files:
- Absolute paths (starting with a path separator).
- Relative from the file that includes them (starting with `./` or `../`).
- Relative from the _docs/_ directory.
- Relative from the _docs/_ directory. For instance, _includes/header.md_ will match the file _docs/includes/header.md_.
- [Bash wildcard globs] matching multiple local files.

File paths to include and string arguments can be wrapped by double `"` or
Expand Down Expand Up @@ -177,7 +177,7 @@ content to include.

```jinja
{%
include-markdown 'docs/includes/header.md'
include-markdown 'includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
Expand All @@ -187,7 +187,7 @@ content to include.

```jinja
{%
include-markdown "docs/includes/header.md"
include-markdown "includes/header.md"
heading-offset=1
%}
```
Expand Down