Skip to content

Target Docusaurus format #126

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Conversation

gsferreira
Copy link

Hi,

I know that I should have opened an Issue first, but since I've found the following issues that are related and are non-answered, I tried to come up with something that would solve my problem.

I want to generate the Markdown files in a folder structure that makes sense on a Docusaurus docs website.
That means some conventions from Jekyll need to be overridden with different rules.
I've found 2:

  1. Files should be organized in a folder tree following the namespaces.
  2. Types should be in the same folder as the methods/properties.

On this PR I add a flag type-folders to address the second point.

And I've built a new console project, that can be delivered as a dotnet tool, that plugs the Docusaurus file path rules into the generator.

Let me know if this is useful. It's solving my problem at the moment.
I'm happy to fine-tune it based on your feedback.

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

Successfully merging this pull request may close these issues.

1 participant