diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..92c5c1b --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,49 @@ +name: deploy to github pages + +on: + push: + branches: + - master + +permissions: + contents: write + pages: write + id-token: write + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + + - name: install beautifulsoup4 for parsing html + run: pip install beautifulsoup4 + + - name: generate docs search indexes + run: python docs/util_scripts/generate_search_index.py + + - name: commit search indexes + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git add **/search_index.json + git diff --cached --quiet || git commit -m "update documentation search indexes [skip ci]" + git push + + - name: upload pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: . + + - name: deploy to github pages + uses: actions/deploy-pages@v4 + + + + + + diff --git a/docs/contents.html b/docs/contents.html index 0dd21cc..b33e785 100644 --- a/docs/contents.html +++ b/docs/contents.html @@ -1,45 +1,54 @@ + +
+
+ MusE Sequencer +
+
+ + +
-

MusE Documentation

+

MusE Documentation

diff --git a/docs/css/main.css b/docs/css/main.css index ff15087..56a1f69 100644 --- a/docs/css/main.css +++ b/docs/css/main.css @@ -1,219 +1,289 @@ - #container { - width: 100%; - - } - - img { - max-width: 100%; - display: block; - margin-left: auto; - margin-right: auto; - } - - #logo { - float: left; - vertical-align: center; - } - - #contents { - top: 0px; - left: 0; - height: 100%; - position: fixed; - width: 300px; - background-color: #008080; - z-index: 500 - } - - #maincontainer { - width: 99.5%; - position: fixed; - top: 0; - /* margin-left: 300px; */ - overflow-y: auto; - height: 100%; - z-index: 300; - background-color: white; - - } - - #main { - /*position: fixed;*/ - top: 0; - /* height: 100%; */ - padding-left: 20px; - padding-right: 50px; - max-width: 1000px; - margin-left: 300px; - background-color: white; - color: black; - - } - - ul { - list-style-type: none; - } - - a:link { - text-decoration: none; - } - - a:visited { - text-decoration: none; - } - - a:hover { - text-decoration: underline; - } - - a:active { - text-decoration: underline; - } - - a.contentlink:link { - color: #f5f5f5; - font-weight: bold; - } - - a.contentlink:visited { - color: #f5f5f5; - font-weight: bold; - } - - a.contentlink:hover { - color: #feff85; - font-weight: bold; - } - - a.contentlink:active { - color: #f5f5f5; - font-weight: bold; - } - - - p.backto { - text-align: center; - } - - - /* mobile responsive design */ - #mobile-bar { - display: none; - position: fixed; - justify-content: center; - align-items: center; - top: 0px; - left: 0px; - z-index: 600; - height: 52px; - width: 100%; - color: white; - background-color: #008080; - } - - #mobile-bar>h2 { - text-align: center; - line-height: 52px; - font-size: 18px; - font-weight: bolder; - } - - #mobile-bar-expand-button { - display: none; - position: fixed; - font-size: 26px; - font-weight: bolder; - padding-left: 12px; - top: 0px; - left: 0px; - z-index: 600; - height: 52px; - color: white; - background-color: transparent; - border: none; - cursor: pointer; - } - - @media screen and (max-width: 1000px) { - #main { - margin: 62px 0px; - } - - #mobile-bar { - display: flex; - } - - #mobile-bar-expand-button { - display: block; - } - - #contents { - transition: height 0.2s; - width: 100%; - height: 52px; +* { + box-sizing: border-box; +} + +#container { + width: 100%; +} + +img { + max-width: 100%; + display: block; + margin-left: auto; + margin-right: auto; +} + +#logo { + float: left; + vertical-align: center; +} + +#logo-container { + margin-top: 15px; + display: flex; + justify-content: center; + align-items: center; +} + +#logo-container a { + display: inline-flex; + font-family: 'Raleway', sans-serif; + font-size: 24px; + font-weight: bold; + color: white; + justify-content: center; + align-items: center; +} + +#logo-container a:hover { + text-decoration: none; +} + +#logo-container img { + margin-right: 5px; +} + +#contents { + top: 0px; + left: 0; + height: 100%; + position: fixed; + width: 300px; + background-color: #008080; + z-index: 500 +} + +#main { + top: 0; + left: 0; + + height: 100%; + max-width: 100em; + + margin-left: 300px; + background-color: white; + color: black; + + overflow-y: auto; + z-index: 300; + background-color: white; +} + +.note { + padding: 10px; + background-color: antiquewhite; + border-radius: 5px; + margin-bottom: 10px +} + +.note::before { + content: "Note: "; + font-weight: bold; +} + +ul { + list-style-type: none; +} + +a:link { + text-decoration: none; +} + +a:visited { + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +a:active { + text-decoration: underline; +} + +a.contentlink:link { + color: #f5f5f5; + font-weight: bold; +} + +a.contentlink:visited { + color: #f5f5f5; + font-weight: bold; +} + +a.contentlink:hover { + color: #feff85; + font-weight: bold; +} + +a.contentlink:active { + color: #f5f5f5; + font-weight: bold; +} + + +p.backto { + text-align: center; +} + + +#mini-searchbar-container { + display: flex; + overflow: hidden; + justify-content: center; + align-items: center; + max-height: 3em; + margin: 0.7em; + margin-left: 0px; + padding-right: 5px; +} + +#mini-searchbar { + font-size: 13px; + padding: 8px; + padding-left: 1.9em; + width: 90%; + border-radius: 2rem; + margin: 0px; +} + +#mini-searchbar-icon { + position: relative; + left: 1.4em; + bottom: 0.1em; + font-size: 23px; + padding: 10px; +} + + + +/* mobile responsive design */ +#mobile-bar { + display: none; + position: fixed; + justify-content: center; + align-items: center; + top: 0px; + left: 0px; + z-index: 600; + height: 52px; + width: 100%; + color: white; + background-color: #008080; + cursor: pointer; +} + +#mobile-bar>h2 { + text-align: center; + line-height: 52px; + font-size: 18px; + font-weight: bolder; +} + +#mobile-bar-expand-button { + display: none; + position: fixed; + font-size: 26px; + font-weight: bolder; + padding-left: 12px; + padding-right: 12px; + top: 0px; + left: 0px; + z-index: 600; + height: 52px; + color: white; + background-color: transparent; + border: none; + pointer-events: none; +} + +#mobile-bar:hover #mobile-bar-expand-button { + background-color: #109090; +} + + + + +@media screen and (max-width: 1000px) { + #main { + margin: 62px 0px; + } + + #mobile-bar { + display: flex; + } + + #mobile-bar-expand-button { + display: block; + } + + #contents { + transition: height 0.2s; + width: 100%; + height: 52px; overflow-y: auto; - } + } - #contents-list { - margin-top: 64px; - } + #contents-list { + margin-top: 64px; + } - #contents-list ul li { - position: relative; - border-top: solid 1px transparent; - padding-top: 24px; - padding-bottom: 24px; - text-align: center; - } + #contents-list ul li { + position: relative; + border-top: solid 1px transparent; + padding-top: 24px; + padding-bottom: 24px; + text-align: center; + } - #contents-list ul { - margin: 0px; - padding: 0px; - } + #contents-list ul { + margin: 0px; + padding: 0px; + } - #contents-list>ul>li:hover, - #contents-list>.backto:hover { - background-color: #109090; - } + #contents-list>ul>li:hover, + #contents-list>.backto:hover { + background-color: #109090; + } - #contents-list>ul>li:hover, - contents-list>.backto:hover { - background-color: #109090; - } + #contents-list>ul>li:hover, + contents-list>.backto:hover { + background-color: #109090; + } - #contents-list li a { - position: absolute; - inset: 0; - display: flex; - align-items: center; - justify-content: center; - transition: color 0.2s; - color: transparent; - } + #contents-list li a { + position: absolute; + inset: 0; + display: flex; + align-items: center; + justify-content: center; + transition: color 0.2s; + color: transparent; + } - #contents-list .backto a { - font-size: 20px; - } + #contents-list .backto a { + font-size: 20px; + } - #contents.expanded { - transition: height 0.2s; - height: 100%; - } + #contents.expanded { + transition: height 0.2s; + height: 100%; + } - #contents.expanded #contents-list li { - border-color: #ffffff72; - transition: border-color 0.2s; - } + #contents.expanded #contents-list li { + border-color: #ffffff72; + transition: border-color 0.2s; + } - #contents.expanded li a { - transition: color 0.2s; - color: white; - } + #contents.expanded li a { + transition: color 0.2s; + color: white; + } - } +} diff --git a/docs/css/search.css b/docs/css/search.css new file mode 100644 index 0000000..4f9c666 --- /dev/null +++ b/docs/css/search.css @@ -0,0 +1,97 @@ +mark { + background: yellow; + font-weight: bold; +} + +#searchbar-container { + display: flex; + overflow: hidden; + justify-content: center; + align-items: center; + max-height: 3em; +} + +#search-icon { + position: relative; + left: 1.4em; + padding-bottom: 6px; + font-size: 23px; + z-index: 1; +} + +#searchbar { + font-size: 17px; + padding: 8px; + padding-left: 2.1em; + width: 100%; + border-radius: 2rem; +} + +#searchresults { + display: block; + + justify-content: center; + align-items: center; + + overflow: auto; + + padding: 2px 1em; + width: 100%; + margin: auto; + margin-top: 4px; + border-radius: 0.4em; + padding-bottom: 6px; +} + +.search-result { + width: 100%; + border: solid 1px black; + border-radius: 0.4em; + margin-bottom: 12px; + overflow: hidden; + + position: relative; +} + +.search-result-header { + width: 100%; + background-color: #008080; + color: white; + padding: 6px; + height: 2em; +} + +.search-result-header a { + position: absolute; + inset: 0; +} + +.search-result-title { + text-decoration: none; + color: white; + font-size: 1.1em; + font-weight: bold; +} + +.search-result-ocurrences-count { + color: #e0e0e0; + margin-left: 10px; + font-size: 0.9em; + font-weight: bolder; +} + +.search-result:has(a:hover) { + background-color: lightgray; +} + +.search-result-content { + overflow: auto; + padding: 5px; +} + +#message { + margin-top: 6px; + width: 100%; + text-align: center; + color: gray; +} diff --git a/docs/editoruse.html b/docs/editoruse.html index 37ed012..154492b 100644 --- a/docs/editoruse.html +++ b/docs/editoruse.html @@ -13,6 +13,7 @@
+

Editor Use

Arranger: Creating, moving, resizing, copying, cloning, deleting parts

While drawing a new part, press: * No keys/buttons: Part is resized horizontally in-place. Part can move vertically. * Right-click/Ctrl: Move part horizontally, don’t resize. Part snaps to the grid. * Right-click/Ctrl + Shift: Same as Right-click/Ctrl, but do not snap to the grid.

Moving, copying, or cloning existing parts by dragging them:

diff --git a/docs/es/contents.html b/docs/es/contents.html index 5afa5a2..77cfe0e 100644 --- a/docs/es/contents.html +++ b/docs/es/contents.html @@ -1,159 +1,192 @@ + +
+ +
+ + +