Skip to content

documentation search bar #8

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.

Sign up for GitHub

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

Open
fiumals wants to merge 13 commits into
base: master
Choose a base branch
from
Open

documentation search bar #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fc82d25
searchbar wip
fiumals Apr 13, 2026
6a1248d
search bar finish
fiumals Apr 27, 2026
1fba591
small change to search index generation script
fiumals Apr 27, 2026
db4ed36
Merge branch 'muse-sequencer:master' into master
fiumals Apr 27, 2026
d3be8ca
small fix for spanish search page
fiumals Apr 27, 2026
204aa37
small change in search index script
fiumals Apr 27, 2026
260e6f9
create github workflow to generate search indexes
fiumals May 1, 2026
9221c02
update documentation search indexes [skip ci]
github-actions[bot] May 1, 2026
4d8c052
fix english search index generation
fiumals May 1, 2026
d307fd9
update documentation search indexes [skip ci]
github-actions[bot] May 1, 2026
a7e1ef5
test wiki search generation by modifying spanish files and deleting t…
fiumals May 1, 2026
954588d
update documentation search indexes [skip ci]
github-actions[bot] May 1, 2026
4d2d8b8
fixed images in spanish wikiedit.html
fiumals May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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






79 changes: 44 additions & 35 deletions docs/contents.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,54 @@
<!-- WARNING: due to the way the sidebar is inserted in the articles, <script> elements inserted in this file will not run automatically -->
<link
href="https://fonts.googleapis.com/css?family=Raleway&display=swap"
rel="stylesheet"
/>

<div id="contents-list">
<div id="logo-container">
<a href="../" title="Return to homepage"><img src="../img/muse_icon_64x64.png" align="top" height="36" width="36">MusE Sequencer</a>
</div>
<div id="mini-searchbar-container">
<span id="mini-searchbar-icon">⌕</span>
<input id="mini-searchbar" href="search.html" placeholder="Search Documentation..." />
</div>
<ul>
<li>
<p class="backto"><a href="https://muse-sequencer.github.io/" class="contentlink" target="_parent">Return to homepage</a></p>
</li>
<li ><a href="intro.html" class="contentlink" target="_parent">Introduction</a></li>
<li ><a href="download.html" class="contentlink" target="_parent">Downloading</a></li>
<li ><a href="start.html" class="contentlink" target="_parent">Getting up and Running</a></li>
<li ><a href="beginners.html" class="contentlink" target="_parent">Beginners Tutorial</a></li>
<li ><a href="basic.html" class="contentlink" target="_parent">Basic overview of MusE</a></li>
<li ><a href="projects.html" class="contentlink" target="_parent">Projects</a></li>
<li ><a href="editing.html" class="contentlink" target="_parent">Editing in MusE</a></li>
<li ><a href="drum.html" class="contentlink" target="_parent">Drum Editor</a></li>
<li ><a href="event.html" class="contentlink" target="_parent">Event Editor</a></li>
<li ><a href="mastertrack.html" class="contentlink" target="_parent">Mastertrack Editor</a></li>
<li ><a href="panic.html" class="contentlink" target="_parent">The Panic Toolbar</a></li>
<li ><a href="tracks.html" class="contentlink" target="_parent">Tracks and parts</a></li>
<li ><a href="routes.html" class="contentlink" target="_parent">Routes</a></li>
<li ><a href="trackssolo.html" class="contentlink" target="_parent">Track Soloing</a></li>
<li ><a href="scripts.html" class="contentlink" target="_parent">Scripts</a></li>
<li ><a href="plugins.html" class="contentlink" target="_parent">Plugins</a></li>
<li ><a href="metronome.html" class="contentlink" target="_parent">Metronome Configuration</a></li>
<li ><a href="automation.html" class="contentlink" target="_parent">Automation</a></li>
<li ><a href="configuration.html" class="contentlink" target="_parent">Configuration</a></li>
<li ><a href="editoruse.html" class="contentlink" target="_parent">Editor Usage</a></li>
<li ><a href="shortcuts.html" class="contentlink" target="_parent">Useful Keyboard Shortcuts</a></li>
<li ><a href="uicustom.html" class="contentlink" target="_parent">Customizing the U.I.</a></li>
<li ><a href="definitions.html" class="contentlink" target="_parent">Instrument Definitions</a></li>
<li ><a href="pythonrc.html" class="contentlink" target="_parent">Python Remote Control</a></li>
<li ><a href="support.html" class="contentlink" target="_parent">Support/FAQ</a></li>
<li ><a href="helping.html" class="contentlink" target="_parent">Helping</a></li>
<li ><a href="i18n.html" class="contentlink" target="_parent">Internationalisation</a></li>
<li ><a href="tutorials.html" class="contentlink" target="_parent">Tutorials</a></li>
<li ><a href="demos.html" class="contentlink" target="_parent">Demos and demo songs</a></li>
<li ><a href="screenshots.html" class="contentlink" target="_parent">Screenshots</a></li>
<li ><a href="wikiedit.html" class="contentlink" target="_parent">Editing This Wiki</a></li>
<li ><a href="intro.html" class="contentlink articlelink" target="_parent">Introduction</a></li>
<li ><a href="download.html" class="contentlink articlelink" target="_parent">Downloading</a></li>
<li ><a href="start.html" class="contentlink articlelink" target="_parent">Getting up and Running</a></li>
<li ><a href="beginners.html" class="contentlink articlelink" target="_parent">Beginners Tutorial</a></li>
<li ><a href="basic.html" class="contentlink articlelink" target="_parent">Basic overview of MusE</a></li>
<li ><a href="projects.html" class="contentlink articlelink" target="_parent">Projects</a></li>
<li ><a href="editing.html" class="contentlink articlelink" target="_parent">Editing in MusE</a></li>
<li ><a href="drum.html" class="contentlink articlelink" target="_parent">Drum Editor</a></li>
<li ><a href="event.html" class="contentlink articlelink" target="_parent">Event Editor</a></li>
<li ><a href="mastertrack.html" class="contentlink articlelink" target="_parent">Mastertrack Editor</a></li>
<li ><a href="panic.html" class="contentlink articlelink" target="_parent">The Panic Toolbar</a></li>
<li ><a href="tracks.html" class="contentlink articlelink" target="_parent">Tracks and parts</a></li>
<li ><a href="routes.html" class="contentlink articlelink" target="_parent">Routes</a></li>
<li ><a href="trackssolo.html" class="contentlink articlelink" target="_parent">Track Soloing</a></li>
<li ><a href="scripts.html" class="contentlink articlelink" target="_parent">Scripts</a></li>
<li ><a href="plugins.html" class="contentlink articlelink" target="_parent">Plugins</a></li>
<li ><a href="metronome.html" class="contentlink articlelink" target="_parent">Metronome Configuration</a></li>
<li ><a href="automation.html" class="contentlink articlelink" target="_parent">Automation</a></li>
<li ><a href="configuration.html" class="contentlink articlelink" target="_parent">Configuration</a></li>
<li ><a href="editoruse.html" class="contentlink articlelink" target="_parent">Editor Usage</a></li>
<li ><a href="shortcuts.html" class="contentlink articlelink" target="_parent">Useful Keyboard Shortcuts</a></li>
<li ><a href="uicustom.html" class="contentlink articlelink" target="_parent">Customizing the U.I.</a></li>
<li ><a href="definitions.html" class="contentlink articlelink" target="_parent">Instrument Definitions</a></li>
<li ><a href="pythonrc.html" class="contentlink articlelink" target="_parent">Python Remote Control</a></li>
<li ><a href="support.html" class="contentlink articlelink" target="_parent">Support/FAQ</a></li>
<li ><a href="helping.html" class="contentlink articlelink" target="_parent">Helping</a></li>
<li ><a href="i18n.html" class="contentlink articlelink" target="_parent">Internationalisation</a></li>
<li ><a href="tutorials.html" class="contentlink articlelink" target="_parent">Tutorials</a></li>
<li ><a href="demos.html" class="contentlink articlelink" target="_parent">Demos and demo songs</a></li>
<li ><a href="screenshots.html" class="contentlink articlelink" target="_parent">Screenshots</a></li>
<li ><a href="wikiedit.html" class="contentlink articlelink" target="_parent">Editing This Wiki</a></li>
</ul>
</div>
<div id="mobile-bar">
<button id="mobile-bar-expand-button">☰</button>
<h2>MusE Documentation</h2>
<h2 id="mobile-bar-title">MusE Documentation</h2>
</div>


Loading