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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: customize Material for mkdocs #264

Merged
merged 8 commits into from
Feb 1, 2024

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Feb 1, 2024

So we're ready to start writing

Monkey typing

There are maaaaaaaaaany things here (went checking each of mkdocs docs pages) buuuuut some of them:

  • Custom colors according to logo
  • Custom font (same as Angular v17 brand guidelines). Loaded via FontSource to avoid Google Fonts injecting 馃崻 s
    • Implies setting up a pkg.json & copying installed fonts to a public directory
    • Removes markdowns after copying to avoid mkdocs displaying those as part of our docs. exclude_docs works partially. As plugins like privacy keep reading those. So removing instead.
    • Customizes CSS to match angular.dev h1, h2 sizes (tho they don't respect guidelines I think)
  • Custom icon & favicon
  • Support for abbreviations / glossary
  • Support for social plugin (generates social cards)
  • Description to be ~200 chars. Ensure fits social card properly.
  • Dark/light themes customization
  • SPA (XHR reqs when navigating) via navigation.instant
  • ToC integrated in navigation + following anchors
  • Go to top navigation
  • Search (with suggestions, highlighting and search link)
  • Edit (and view) doc page on GitHub
  • Tooltips for abbreviations (& tooltips if adding)
  • Tabbed content (with anchor links that change all together / slugs instead of generated anchor names)
  • Code highlighting
  • Nested blocks with superfences
  • Admonitions
  • Footnotes
  • Social links

Minors:

  • Configure WebStorm to use Prettier for CSS
  • Fix docs: serve run config (was installing)
  • Ignore site / .venv / fonts docs directories for Prettier
  • Ignore content/fonts from Git, it's generated
  • Specify English language
  • Custom GitHub repo logo (vs git default)
  • Configuration to serve publicly (ie: to check in another device)

Copy link
Owner Author

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@davidlj95 davidlj95 force-pushed the stacked/docs-customize-Material-for-mkdocs branch from eee4fe7 to 6e2b6a0 Compare February 1, 2024 13:03
@davidlj95 davidlj95 added the preview docs Enables previewing docs in a PR label Feb 1, 2024
Copy link

github-actions bot commented Feb 1, 2024

馃摝 Bundle size (Angular v17)

Git ref: 79a5be4

Module file Size Base size Difference
ngx-meta-core.mjs 2846 bytes (2.8KiB) Not available Not available
ngx-meta-json-ld.mjs 226 bytes (226B) Not available Not available
ngx-meta-open-graph.mjs 888 bytes (888B) Not available Not available
ngx-meta-routing.mjs 839 bytes (839B) Not available Not available
ngx-meta-standard.mjs 784 bytes (784B) Not available Not available
ngx-meta-twitter-card.mjs 501 bytes (501B) Not available Not available
Total 6084 bytes (6.0KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Feb 1, 2024

馃摝 Bundle size (Angular v16)

Git ref: 79a5be4

Module file Size Base size Difference
ngx-meta-core.mjs 3250 bytes (3.2KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1232 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 1015 bytes (1015B) Not available Not available
ngx-meta-standard.mjs 901 bytes (901B) Not available Not available
ngx-meta-twitter-card.mjs 661 bytes (661B) Not available Not available
Total 7451 bytes (7.3KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Feb 1, 2024

馃摝 Bundle size (Angular v15)

Git ref: 79a5be4

Module file Size Base size Difference
ngx-meta-core.mjs 3250 bytes (3.2KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1232 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 1015 bytes (1015B) Not available Not available
ngx-meta-standard.mjs 901 bytes (901B) Not available Not available
ngx-meta-twitter-card.mjs 661 bytes (661B) Not available Not available
Total 7451 bytes (7.3KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

@davidlj95 davidlj95 enabled auto-merge (squash) February 1, 2024 16:38
@davidlj95 davidlj95 merged commit e45bc40 into main Feb 1, 2024
10 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-customize-Material-for-mkdocs branch February 1, 2024 16:39
@davidlj95 davidlj95 linked an issue Feb 1, 2024 that may be closed by this pull request
Copy link

馃帀 This PR is included in version 1.0.0-alpha.39 馃帀

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.

Add docs
1 participant