dineshsonachalam/markdown-autodocs

Is it possible to give a directory as `output_file_paths`?

Closed this issue · 3 comments

anupama-pathirage commented

I need to inject code snippets to many .md files in my project.

So instead of mentioning each .md file one by one as follows, is there any way to give the full directory?

Currently I am achieving it as https://github.com/anupama-pathirage/learning_ballerina/blob/master/.github/workflows/gh-pages.yml#L20

with:
          output_file_paths: '[./src/simple_basic_types/boolean.md,./src/simple_basic_types/decimal.md,./src/simple_basic_types/float.md]'

So my question is can't we have something like below?

with:
          output_file_paths: '[./src/simple_basic_types/*]'

Btw, thanks for great project

dineshsonachalam commented

Thanks for the suggestion @anupama-pathirage. I will raise an MR tomorrow to support this feature.

  • 🎉1
dineshsonachalam commented

Hi, @anupama-pathirage,

I added support to give a directory as output_file_paths. You just need to add this step in your gh-pages.yml.

      - name: Markdown autodocs
        uses: dineshsonachalam/markdown-autodocs@v1.0.4
        with:
          output_file_paths: '[./src/simple_basic_types/*]'

Reference: https://github.com/dineshsonachalam/learning_ballerina/blob/master/.github/workflows/gh-pages.yml

Before Markdown-autodocs: dineshsonachalam/learning_ballerina@b90ff97
After Mardkdown-autodocs: dineshsonachalam/learning_ballerina@0ac4b29

Feel free to reach out if you have any questions.

Thanks,
Dinesh

anupama-pathirage commented

Great. It worked well. Thank you.

  • 👍1