Skip to content

Commit

Permalink
Add: mkdocs and simulation codes
Browse files Browse the repository at this point in the history
  • Loading branch information
Suke0811 committed Sep 27, 2024
1 parent a9818f6 commit e377867
Show file tree
Hide file tree
Showing 29 changed files with 3,722 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: pip install -r requirements_doc.txt
- run: mkdocs gh-deploy --force
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# magpie_sim
# Multi Modal End Effector Force Sensing Simulation
Computational design tools for 3D hall effect sensor based force sensing mechanisms

For documentation, visit:
[https://suke0811.github.io/magpie_sim/](https://suke0811.github.io/magpie_sim/)
4 changes: 4 additions & 0 deletions docs/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

.md-button--red {
background: red;
}
102 changes: 102 additions & 0 deletions docs/css/neoteroi-cards.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.nt-cards.nt-grid {
display: grid;
grid-auto-columns: 1fr;
gap: 0.5rem;
max-width: 100vw;
overflow-x: auto;
padding: 1px;
}
.nt-cards.nt-grid.cols-1 {
grid-template-columns: repeat(1, 1fr);
}
.nt-cards.nt-grid.cols-2 {
grid-template-columns: repeat(2, 1fr);
}
.nt-cards.nt-grid.cols-3 {
grid-template-columns: repeat(3, 1fr);
}
.nt-cards.nt-grid.cols-4 {
grid-template-columns: repeat(4, 1fr);
}
.nt-cards.nt-grid.cols-5 {
grid-template-columns: repeat(5, 1fr);
}
.nt-cards.nt-grid.cols-6 {
grid-template-columns: repeat(6, 1fr);
}

@media only screen and (max-width: 600px) {
.nt-cards.nt-grid {
grid-template-columns: repeat(1, 1fr) !important;
}
}
.nt-card {
box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 3px 1px -2px rgba(0, 0, 0, 0.2), 0 1px 5px 0 rgba(0, 0, 0, 0.12);
}
.nt-card:hover {
box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.24), 0 3px 1px -2px rgba(0, 0, 0, 0.3), 0 1px 5px 0 rgba(0, 0, 0, 0.22);
}

[data-md-color-scheme=slate] .nt-card {
box-shadow: 0 2px 2px 0 rgba(4, 40, 33, 0.14), 0 3px 1px -2px rgba(40, 86, 94, 0.47), 0 1px 5px 0 rgba(139, 252, 255, 0.64);
}
[data-md-color-scheme=slate] .nt-card:hover {
box-shadow: 0 2px 2px 0 rgba(0, 255, 206, 0.14), 0 3px 1px -2px rgba(33, 156, 177, 0.47), 0 1px 5px 0 rgba(96, 251, 255, 0.64);
}

.nt-card > a {
color: var(--md-default-fg-color);
}

.nt-card > a > div {
cursor: pointer;
}

.nt-card {
padding: 5px;
margin-bottom: 0.5rem;
}

.nt-card-title {
font-size: 1rem;
font-weight: bold;
margin: 4px 0 8px 0;
line-height: 22px;
}

.nt-card-content {
padding: 0.4rem 0.8rem 0.8rem 0.8rem;
}

.nt-card-text {
font-size: 14px;
padding: 0;
margin: 0;
}

.nt-card .nt-card-image {
text-align: center;
border-radius: 2px;
background-position: center center;
background-size: cover;
background-repeat: no-repeat;
min-height: 120px;
}

.nt-card .nt-card-image.tags img {
margin-top: 12px;
}

.nt-card .nt-card-image img {
height: 105px;
margin-top: 5px;
}

.nt-card a:hover,
.nt-card a:focus {
color: var(--md-accent-fg-color);
}

.nt-card h2 {
margin: 0;
}
Loading

0 comments on commit e377867

Please sign in to comment.