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

Update README.md + Add support for Markdown/HTML + Update loop targets #10

Open
wants to merge 9 commits into
base: next
Choose a base branch
from

Conversation

sheriffMoose
Copy link

@sheriffMoose sheriffMoose commented Jan 19, 2023

Issue: N/A

What Changed

  • Docs: update README.md with more info about the output & Getting started section.
  • Feat: add support for analyzing Markdown/HTML files for title via the <title> tag.
  • Feat: add support for tags (was supposed to be there as it is already being referenced in StoryIndexGenerator.ts.
  • Maintenance: update the analyze loop to target only Meta elements instead of all elements.
  • Maintenance: enable running unit tests on pull requests

How to test

  • CI passes.
  • Check updated unit tests.

Change Type

  • maintenance
  • documentation
  • minor

filter the elements that goes into the loop to work with `Meta` elements only instead of all elements
allows extracting `title` from `.md` & `.html` docs via the `<title></title>` element
add getting started info + more details about the output
missing feature that is supposed to exist as it is being called already in StoryIndexGenerator
@sheriffMoose sheriffMoose added documentation Changes only affect the documentation enhancement New feature or request maintenance labels Jan 19, 2023
@sheriffMoose sheriffMoose marked this pull request as ready for review January 20, 2023 00:18
src/analyze.test.ts Outdated Show resolved Hide resolved
src/analyze.test.ts Outdated Show resolved Hide resolved
src/analyze.test.ts Outdated Show resolved Hide resolved
@fbjaras
Copy link

fbjaras commented Dec 14, 2023

@sheriffMoose @shilman Hi! Any plan to approve/merge this? Would love to be able to set tags on unattached docs, since i cannot seem to find any other way to do that without this! Thanks! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation enhancement New feature or request maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants