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

279: Generate sidebar nav items from the scanned md files #62

Conversation

javisperez
Copy link
Contributor

This PR adds a node script that reads the content of a docs folder and adds all *.md found files in the sidenav.

Preview

Screen.Recording.2024-03-05.at.11.01.40.AM.mov

@javisperez javisperez requested a review from gorkem March 5, 2024 15:03
@javisperez javisperez self-assigned this Mar 5, 2024
Copy link

This pull request has been linked to Shortcut Story #279: Add option to generate the sidenav from scaning *.md files.

@@ -4,39 +4,39 @@ Create a tag that refers to a modelkit

### Synopsis

Create or update a tag <target-modelkit> that refers to <source-modelkit>
Create or update a tag `target-modelkit` that refers to `source-modelkit`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<target-modelkit> was being handled as html and therefor failing to parse. Had to remove the <>.

modelkits, making it easier to organize, retrieve, and deploy specific
iterations. Ensure tags are meaningful and consistent across your team or
modelkits, making it easier to organize, retrieve, and deploy specific
iterations. Ensure tags are meaningful and consistent across your team or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this file should probably be applied to the longDesc in this file instead, since they will be lost when docs are regenerated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I'm totally going to add trailing whitespace to our PR checks :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, FWIW, this was updated by the editorconfig settings so, vscode did it on save 😬 .

@gorkem
Copy link
Contributor

gorkem commented Mar 5, 2024

@javisperez this needs a rebase

@javisperez javisperez merged commit 879641d into main Mar 6, 2024
1 check passed
@javisperez javisperez deleted the javisperez/sc-279/add-option-to-generate-the-sidenav-from-scaning branch March 6, 2024 15:11
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.

3 participants