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

Non-JS Doc Metadata #5

Open
coreybutler opened this issue Oct 1, 2018 · 0 comments
Open

Non-JS Doc Metadata #5

coreybutler opened this issue Oct 1, 2018 · 0 comments
Assignees

Comments

@coreybutler
Copy link
Member

Metadoc is great for producing API metadata, but there is currently nothing for generating guides. Guides are almost always static HTML sites (not just a page). It's possible to identify the structure of an individual document by it's headings (like the <h1> tag), but there isn't much for producing a master index/table of contents.

Metadoc should be capable of producing indexes that can be used to generate a table of contents for a guide.

This may require some inspection of directory/folder structures to determine things like chapters, subchapters, or other types of volumes. Metadoc may also need to parse the markdown/HTML content for comments to assist with this. Finally, it should be capable of verifying links between documents.

@coreybutler coreybutler self-assigned this Oct 1, 2018
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