Skip to content
This repository has been archived by the owner on Dec 24, 2022. It is now read-only.

Generate .md docs from source code #2

Open
mrbrianevans opened this issue Nov 2, 2021 · 3 comments
Open

Generate .md docs from source code #2

mrbrianevans opened this issue Nov 2, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation
Projects
Sprint 2 Sprint 5

Comments

@mrbrianevans
Copy link
Owner

Write a generator that imports the list of supported file types from the source code, and generates markdown documentation with links to the source code.
@mrbrianevans mrbrianevans created this issue from a note in Sprint 1 (To do) Nov 2, 2021
@mrbrianevans
Copy link
Owner Author

Could also have a page on the website which lists all of the supported formats, and has some examples of what they look like

@mrbrianevans mrbrianevans added this to To do in Sprint 2 Nov 3, 2021
@mrbrianevans mrbrianevans added the documentation Improvements or additions to documentation label Nov 3, 2021
@mrbrianevans mrbrianevans removed this from To do in Sprint 1 Nov 4, 2021
@mrbrianevans mrbrianevans added this to To do in Sprint 5 Jan 19, 2022
@mrbrianevans
Copy link
Owner Author

See package @scdev/declarative-markdown for generating markdown

@mrbrianevans
Copy link
Owner Author

Could also have a page on the website which lists all of the supported formats, and has some examples of what they look like

There is now an auto-generated list of vendors on the home page tab with the number of files supported from that vendor.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Sprint 2
To do
Sprint 5
To do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mrbrianevans