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

Suggest changing auto reload configuration when using abbreviations glossary outside docs folder #6456

Closed
2 tasks done
johnthagen opened this issue Dec 7, 2023 · 5 comments · Fixed by #6459
Closed
2 tasks done
Labels
documentation Issue concerns the documentation

Comments

@johnthagen
Copy link
Contributor

Description

The abbreviations documentation recommends using an includes/abbreviations.md file for the glossary. When I tried this out, I noticed that the default project will not reload automatically when that file is changed.

Related links

Proposed change

Recommend adding a small tip recommending that the user change their hot-reload configuration to include the include/ folder so that the reload experience works for the glossary.

Before submitting

@johnthagen johnthagen added the documentation Issue concerns the documentation label Dec 7, 2023
@squidfunk
Copy link
Owner

Thanks for suggesting. Would you like to add this yourself in a PR?

@johnthagen
Copy link
Contributor Author

I would be happy either way. I was not actually sure how to change the reload directories though?

@squidfunk
Copy link
Owner

I think adding them to watch should be sufficient.

@johnthagen
Copy link
Contributor Author

Yes, that worked. I will open a PR.

@squidfunk
Copy link
Owner

Perfect, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue concerns the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants