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.

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

Add underscored docs files to Jekyll include #60

Merged
merged 3 commits into from
Apr 18, 2021

Conversation

eritbh
Copy link
Owner

@eritbh eritbh commented Apr 6, 2021

If Typedoc generates docs files that start with underscores, Jekyll ignores them by default because it ignores all files and folders that start with underscores. Jekyll's include config key can be used to get around this, but it doesn't support glob patterns - only individual files. To work around this, the doc gen script manually adds all underscored files in the generated docs to the include option when pushing the new docs version.

@eritbh eritbh merged commit dcba352 into main Apr 18, 2021
@eritbh eritbh deleted the handle-underscores-in-docgen branch April 18, 2021 02:14
@eritbh eritbh added this to the v2.2.1 milestone Apr 18, 2021
@eritbh eritbh added changes: docs updates the documentation website or doc comments bug something happens that shouldn't version: patch semver-patch, involves correctness fixes labels Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug something happens that shouldn't changes: docs updates the documentation website or doc comments version: patch semver-patch, involves correctness fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant