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

Dynamically build main Markdown file #102

Open
jissereitsma opened this issue Oct 26, 2022 · 1 comment
Open

Dynamically build main Markdown file #102

jissereitsma opened this issue Oct 26, 2022 · 1 comment

Comments

@jissereitsma
Copy link
Collaborator

The current setup of this repo is that there is a single Markdown file, holding all information. As discussed with @DavidLambauer, there could be a huge benefit of splitting up the resources into smaller files (Markdown, CSV, JSON) and using a build tool to parse these resources into the main README.md file. The smaller resource files (like an events.json, an extensions.csv file or simply a about-magento.md file) could then be used elsewhere (remote feeds, website generators) as well.

@jissereitsma
Copy link
Collaborator Author

Perhaps add all of the resources into a folder called resources/. The MVP for this would be two Markdown files in that resources/ folder that are then merged together by a build tool, to override the README.md file. The build tool could be built with Laravel Zero, and automatically run via GitHub Actions with every PR.

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

No branches or pull requests

1 participant