Skip to content

feat(document): add parent title prefix via .pages file #57

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

Open
geopanther wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(document): add parent title prefix via .pages file #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions mdfluence/document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,12 +218,15 @@ def get_pages_from_directory(
.capitalize()
)
folder_title = parent_page_title
use_parent_title_as_prefix = False
if use_pages_file and ".pages" in file_names:
with open(current_path.joinpath(".pages")) as pages_fp:
pages_file_contents = yaml.safe_load(pages_fp)
if "title" in pages_file_contents:
parent_page_title = pages_file_contents["title"]
folder_title = parent_page_title
if pages_file_contents.get("add-parent-title-as-prefix"):
use_parent_title_as_prefix = True

folder_data[current_path]["title"] = folder_title

Expand Down Expand Up @@ -251,6 +254,12 @@ def get_pages_from_directory(
plantuml_path=plantuml_path,
)
processed_page.parent_title = parent_page_title
if (
use_parent_title_as_prefix
and parent_page_title
and processed_page.title
):
processed_page.title = parent_page_title + " " + processed_page.title
processed_pages.append(processed_page)

# This replaces the title for the current folder with the title for the
Expand Down
33 changes: 33 additions & 0 deletions test_package/unit/test_document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,39 @@ def test_get_pages_from_directory_with_pages_file_multi_level(fs):
]


def test_get_pages_from_directory_with_pages_file_multi_level_conflicting_titles(fs):
fs.create_file("/root-folder/sub-folder-a/some-page.md")
fs.create_file("/root-folder/sub-folder-b/some-page.md")
fs.create_file(
"/root-folder/sub-folder-a/.pages",
contents='title: "Folder A"\nadd-parent-title-as-prefix: true',
)
fs.create_file(
"/root-folder/sub-folder-b/.pages",
contents='title: "Folder B"\nadd-parent-title-as-prefix: true',
)

result = doc.get_pages_from_directory(Path("/root-folder"), use_pages_file=True)
assert result == [
FakePage(
title="Folder A",
),
FakePage(
title="Folder A some-page",
file_path=Path("/root-folder/sub-folder-a/some-page.md"),
parent_title="Folder A",
),
FakePage(
title="Folder B",
),
FakePage(
title="Folder B some-page",
file_path=Path("/root-folder/sub-folder-b/some-page.md"),
parent_title="Folder B",
),
]


def test_get_pages_from_directory_with_pages_file_single_level(fs):
fs.create_file("/root-folder/some-page.md")
fs.create_file("/root-folder/.pages", contents='title: "Root folder"')
Expand Down
Loading