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

Sync files which only has title and category attributes in the markdown files #539

Closed
tonilopezmr opened this issue Jul 21, 2022 · 2 comments · Fixed by #729
Closed

Sync files which only has title and category attributes in the markdown files #539

tonilopezmr opened this issue Jul 21, 2022 · 2 comments · Fixed by #729
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request

Comments

@tonilopezmr
Copy link

It could be interesting to have a configuration flag to only sync Markdown files which match the requirements to be uploaded.

Why is this useful? In your example you have a documentation directory, but in some repositories, the docs are spread on different directories. Instead of running the CLI command multiple times indicating those directories, it could be interesting to indicate the root directory, and mark the flag like --silent-continue instead of throw an error because README.md doesn't have the attribute category.

What do you think about It?

@kanadgupta kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Jul 21, 2022
@kanadgupta
Copy link
Member

kanadgupta commented Jul 21, 2022

Thanks for the suggestion @tonilopezmr! We've been ideating1 docs syncing improvements for some time now (e.g. ignore patterns, zero-config) and addressing this type of use case is on our radar. Don't have any specifics or a timeline for you just yet but we'll definitely take your feedback into consideration!

Footnotes

  1. internal note: see RM-4421 and RM-4422

@tonilopezmr
Copy link
Author

INMO having this kind for flag/config for now it could be a nice to have in the meantime you are adding more complete features as ignore patterns and zero-config features.

Thank you @kanadgupta and readme.io team! 💪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants