hackforla / hackforla/internship

Develop Design System Microsite based on Material for MKDocs

Open
#455 9 comments 0 reactions 1 assignee Assigned to @joshfishman View on GitHub
complexity: large epic feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
Dominant language
CSS
Stars
20
Forks
6
PR merge metrics
No merged PRs in 30d

Description

### Dependencies
- #397
- #446

### Overview
We need to develop a microsite to hold the Design System components.
This site should be based on Material for MKDocs and setup to run on the internship repo's Github Pages

### Action Items

- [x] Setup MkDocs for Material Design locally
- [x] Set up microsite on the internship design system
- [ ] Develop Component microsite pages for the Issues below

### Resources/Instructions

- [Contributing to the Internship Design System](https://github.com/hackforla/internship-website-design-system/blob/main/CONTRIBUTING.md)
- [Current Live Version](https://hackforla.github.io/internship-website-design-system/)
- [Getting Started with Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/)
- [Using snippets to include code](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-notation)
- [Material for MkDocs Snippets](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#snippets)
- Spreadsheet: [TWE: Design System Issue Handoff](https://docs.google.com/spreadsheets/d/1aI4n2va-whpNnJ-rQJK7IJAJIOrMY0Ntvw3a5V_SaK4)

### Issues for the epic
- [ ] #399 | #486
- [ ] #400 | #619 | #736
- [ ] #401
- [ ] #402
- [ ] #403
- [ ] #404 | #484
- [ ] #406 | #487
- [ ] #407 | #746
- [ ] #408
- [ ] #409
- [ ] #410
- [ ] #411 | #741
- [ ] #412 | #457
- [ ] #413
- [ ] #414 | #749
- [ ] #415 | #750
- [ ] #416 | #751
- [x] ~#417~ Replaced by #540
- [ ] #418
- [ ] #419
- [x] #420
- [ ] #421
- [ ] #422
- [ ] ~#423~ Replaced by #623
- [ ] #424 | #753
- [ ] #425
- [ ] #426
- [x] #464
- [ ] #510
- [ ] #511
- [ ] #528
- [ ] ~#538~ Replaced by #543
- [x] #622
- [ ] #619 (an issue to update the work done on #400)
- [x] ~#625~ Replaced by #619
- [ ] #626
- [x] #693
- [ ] #731 | #752

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.