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

docs: fix API ref md links downgrading api-documenter #485

Merged

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Apr 2, 2024

Issue or need

Some API reference links in documentation were not working. They displayed the markdown syntax [link text](link URL), but were not processsed as links.

After reviewing the generated Markdown files and latest releases from api-documenter and mkdocs-material, seems that api-documenter recently started to use HTML tables instead of Markdown tables in v7.24.0. And seems mkdocs-material doesn't handle that well.

Proposed changes

Downgrade api-documenter to a previous version where files were pure Markdown. Will see how to solve it better.

Quick reminders

  • 🤝 I will follow Code of Conduct
  • No existing pull request already does almost same changes
  • 👁️ Contributing docs are something I've taken a look at
  • 📝 Commit messages convention has been followed
  • 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
  • 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
  • ⚙️ API Report has been updated if API surface is altered.

Copy link
Owner Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @davidlj95 and the rest of your teammates on Graphite Graphite

@davidlj95 davidlj95 enabled auto-merge (squash) April 2, 2024 19:07
@davidlj95 davidlj95 disabled auto-merge April 2, 2024 19:07
@davidlj95 davidlj95 added the preview docs Enables previewing docs in a PR label Apr 2, 2024
Copy link

github-actions bot commented Apr 2, 2024

📦 Bundle size (Angular v16)

Git ref: 304e7d91dfb3aa730bba2fc45a0b39b17c0f4e86

Module file Size Base size Difference
ngx-meta-core.mjs 3507 bytes (3.5KiB) 3507 bytes (3.5KiB) No change
ngx-meta-json-ld.mjs 392 bytes (392B) 392 bytes (392B) No change
ngx-meta-open-graph.mjs 1238 bytes (1.3KiB) 1238 bytes (1.3KiB) No change
ngx-meta-routing.mjs 1015 bytes (1015B) 1015 bytes (1015B) No change
ngx-meta-standard.mjs 885 bytes (885B) 885 bytes (885B) No change
ngx-meta-twitter-card.mjs 659 bytes (659B) 659 bytes (659B) No change
Total 7696 bytes (7.6KiB) 7696 bytes (7.6KiB) No change

Copy link

github-actions bot commented Apr 2, 2024

📦 Bundle size (Angular v15)

Git ref: 304e7d91dfb3aa730bba2fc45a0b39b17c0f4e86

Module file Size Base size Difference
ngx-meta-core.mjs 3507 bytes (3.5KiB) 3507 bytes (3.5KiB) No change
ngx-meta-json-ld.mjs 392 bytes (392B) 392 bytes (392B) No change
ngx-meta-open-graph.mjs 1238 bytes (1.3KiB) 1238 bytes (1.3KiB) No change
ngx-meta-routing.mjs 1015 bytes (1015B) 1015 bytes (1015B) No change
ngx-meta-standard.mjs 885 bytes (885B) 885 bytes (885B) No change
ngx-meta-twitter-card.mjs 659 bytes (659B) 659 bytes (659B) No change
Total 7696 bytes (7.6KiB) 7696 bytes (7.6KiB) No change

Copy link

github-actions bot commented Apr 2, 2024

📦 Bundle size (Angular v17)

Git ref: 304e7d91dfb3aa730bba2fc45a0b39b17c0f4e86

Module file Size Base size Difference
ngx-meta-core.mjs 3094 bytes (3.1KiB) 3094 bytes (3.1KiB) No change
ngx-meta-json-ld.mjs 226 bytes (226B) 226 bytes (226B) No change
ngx-meta-open-graph.mjs 899 bytes (899B) 899 bytes (899B) No change
ngx-meta-routing.mjs 839 bytes (839B) 839 bytes (839B) No change
ngx-meta-standard.mjs 768 bytes (768B) 768 bytes (768B) No change
ngx-meta-twitter-card.mjs 499 bytes (499B) 499 bytes (499B) No change
Total 6325 bytes (6.2KiB) 6325 bytes (6.2KiB) No change

@davidlj95
Copy link
Owner Author

@davidlj95 davidlj95 merged commit e9fbb4d into main Apr 2, 2024
18 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-fix-api-ref-md-links-downgrading-api-documenter branch April 2, 2024 19:29
Copy link

🎉 This PR is included in version 1.0.0-beta.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview docs Enables previewing docs in a PR released on @main
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant