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: setup initial mkdocs & deployment #257

Merged
merged 12 commits into from
Jan 29, 2024

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Jan 29, 2024

Sets up mkdocs with Material "theme" (it's way moooore than that)

Adds CI workflow to deploy to Cloudflare Pages. Cloudflare Pages was chosen so we can have previews of changes in PRs). Also, built-in deployment command of mkdocs forces a push to gh-pages which meh, can be replaced by a GitHub Actions workflow (as instructed in Material for Mkdocs). CI workflow runs for every push to main or if PR has preview docs tag

Configures IDE JSON schema for mkdocs.yml according to Material for Mkdocs setup guide

Adds IDE run configs to generate docs locally

Sets up some fields in mkdocs.yml config

Changes description to fit 200 chars

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-setup-initial-mkdocs-deployment branch 2 times, most recently from e1646c2 to 148f4e2 Compare January 29, 2024 18:10
@davidlj95 davidlj95 force-pushed the stacked/docs-setup-initial-mkdocs-deployment branch from 148f4e2 to e69b51b Compare January 29, 2024 18:15
@davidlj95 davidlj95 added the preview docs Enables previewing docs in a PR label Jan 29, 2024
@davidlj95 davidlj95 force-pushed the stacked/docs-setup-initial-mkdocs-deployment branch from ce3268f to 5c27409 Compare January 29, 2024 18:43
Copy link

📦 Bundle size (Angular v17)

Git ref: 49d5a4c

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

Copy link

📦 Bundle size (Angular v15)

Git ref: 49d5a4c

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

Copy link

📦 Bundle size (Angular v16)

Git ref: 49d5a4c

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

@davidlj95 davidlj95 merged commit e4951da into main Jan 29, 2024
14 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-setup-initial-mkdocs-deployment branch January 29, 2024 19:12
@davidlj95 davidlj95 linked an issue Feb 1, 2024 that may be closed by this pull request
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs
1 participant