When publishing a directory of markdown files, add option to skip over certain files

[golharam]

As part of my GitHub code repository, I have a README.md and other associated markdown files that I want to publish to Confluence. The README.md refers to the other markdown files.

I have a few markdown files, including CHANGELOG.md, that I don't want published to Confluence, but it's being picked up. Since the markdown does not have a page_id, I get the error: "expected: Confluence page ID to act as parent for Markdown files with no linked Confluence page"

How do I skip over some markdown files? Ideally, I'd like to start with a root document (README.md) and only published the markdown files the root document refers to and skip the others.

[golharam]

I'd also like to ignore entire directories. I just came across a situation where README.md is being picked up from a .pytest_cache folder.

[hunyadi]

Are you using the latest version from master? Since changes introduced in the commit Add ability to index and synchronize directories recursively, hidden files and directories (name starting with .) are automatically skipped.

Currently, md2conf is implemented as a two-pass utility:

• First, it scans the directory you specify. It includes Markdown files but excludes hidden files. For each Markdown file, it extracts metadata, which allows files to be cross-referenced.
• Second, it generates XHTML (Confluence Storage Format) for all the Markdown documents it has found. Links that point to documents that have not been been scanned in the previous phase will raise an error (unless the ignore broken links option is on).

At the time of writing, no reference graph is built that would track which document is referencing which other document such that documents with no inbound links can be skipped. However, this could definitely be a future improvement.

As an alternative solution, we could consider an .mdignore, a file similar to .gitignore and .dockerignore that would exclude specific patterns.

[hunyadi]

Support for ignoring files with .mdignore has been added, and is available on the branch master. Building a reference graph is not yet implemented but may be in a future version.