Skip to content

Add includeDirs Option to configuration #28

Description

@NextDesign1

We have a lot of documentation stored as .txt files. Unfortunately however, all of our CMake files are also stored in .txt files, and we don't want to index those. My current work-around is to rename all of the documentation that we wish to index to .md, and to add .md files to the list of indexable file types. This isn't a great solution however as 1. Our documentation doesn't fallow traditional markdown rules and 2. if a document is updated and we update the repo, it will cause a conflict. It would be great it we could somehow have more fine-grained control over what is an isn't filtered. For instance, it would be nice to have a list of folders to include, rather than exclude. It would also be useful to provide specific filenames that should be ignored, which would allow us to filter out CMakeLists.txt.

My main desire for parsing our documentation is so that the semantic search knows what all of our internal acronyms and terms are, as currently it only provides a rough guess.

What are your thoughts?

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions