diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index c98066d..0000000 --- a/.github/workflows/pages.yml +++ /dev/null @@ -1,69 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. - -# Sample workflow for building and deploying a Jekyll site to GitHub Pages -name: Deploy Jekyll site to Pages - -on: - push: - branches: ["dev", "stable"] - paths: - - "docs/**" - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true - -jobs: - # Build job - build: - runs-on: ubuntu-latest - defaults: - run: - working-directory: docs - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: "3.3" - bundler-cache: true - cache-version: 0 - working-directory: "${{ github.workspace }}/docs" - - name: Setup Pages - id: pages - uses: actions/configure-pages@v5 - - name: Build with Jekyll - # Outputs to the './_site' directory by default - run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" - env: - JEKYLL_ENV: production - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: docs/_site/ - - # Deployment job - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/docs/faq.md b/FAQ/FAQ.md similarity index 90% rename from docs/faq.md rename to FAQ/FAQ.md index 6c7199b..8a23cc9 100644 --- a/docs/faq.md +++ b/FAQ/FAQ.md @@ -1,10 +1,3 @@ ---- -layout: default -title: FAQ -layout: FAQ -nav_order: 2 ---- - ### I couldn't see any button that I can interact with This app is built with immersive experience, just hover your mouse on the top/bottom area of the app and then you'll see everything. @@ -17,13 +10,13 @@ This app is built with immersive experience, just hover your mouse on the top/bo ![alt text](image-6.png) -Again, hover you mouse on the top, click on the lock icon and you're good to go! +Again, hover you mouse on the top, click on the lock icon and you're good to go! Or, alternatively, press `Ctrl + Alt + U`. ### How can I unlock the window in desktop mode ![alt text](image-7.png) -It's in the system tray, right-click on the icon and you'll see "Unlock the window". +It's in the system tray, right-click on the icon and you'll see "Unlock the window". Or, alternatively, press `Ctrl + Alt + U`. ### There's a delay in lyrics timeline diff --git a/docs/image-1.png b/FAQ/image-1.png similarity index 100% rename from docs/image-1.png rename to FAQ/image-1.png diff --git a/docs/image-2.png b/FAQ/image-2.png similarity index 100% rename from docs/image-2.png rename to FAQ/image-2.png diff --git a/docs/image-3.png b/FAQ/image-3.png similarity index 100% rename from docs/image-3.png rename to FAQ/image-3.png diff --git a/docs/image-4.png b/FAQ/image-4.png similarity index 100% rename from docs/image-4.png rename to FAQ/image-4.png diff --git a/docs/image-5.png b/FAQ/image-5.png similarity index 100% rename from docs/image-5.png rename to FAQ/image-5.png diff --git a/docs/image-6.png b/FAQ/image-6.png similarity index 100% rename from docs/image-6.png rename to FAQ/image-6.png diff --git a/docs/image-7.png b/FAQ/image-7.png similarity index 100% rename from docs/image-7.png rename to FAQ/image-7.png diff --git a/docs/image.png b/FAQ/image.png similarity index 100% rename from docs/image.png rename to FAQ/image.png diff --git a/README.CN.md b/README.CN.md index ca780ce..ae29de9 100644 --- a/README.CN.md +++ b/README.CN.md @@ -1,5 +1,7 @@ _**Click here to see the English version**_ +_**点此处查看常见问题与解答（FAQ）**_ +
diff --git a/README.md b/README.md index d0fb7d5..7975094 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ _**点此处查看中文说明**_ +_**Click here to view frequently asked questions (FAQ)**_ +
diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index fb982b7..0000000 --- a/docs/Gemfile +++ /dev/null @@ -1,7 +0,0 @@ -source 'https://rubygems.org' - -gem "jekyll", "~> 4.4.1" # installed by `gem jekyll` -# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 - -gem "just-the-docs", "0.10.1" # pinned to the current release -# gem "just-the-docs" # always download the latest release diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock deleted file mode 100644 index 2052fe4..0000000 --- a/docs/Gemfile.lock +++ /dev/null @@ -1,97 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) - base64 (0.2.0) - bigdecimal (3.1.9) - colorator (1.1.0) - concurrent-ruby (1.3.5) - csv (3.3.2) - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - eventmachine (1.2.7) - ffi (1.17.1-arm64-darwin) - ffi (1.17.1-x86_64-linux-gnu) - forwardable-extended (2.6.0) - google-protobuf (4.29.3-arm64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.29.3-x86_64-linux) - bigdecimal - rake (>= 13) - http_parser.rb (0.8.0) - i18n (1.14.7) - concurrent-ruby (~> 1.0) - jekyll (4.4.1) - addressable (~> 2.4) - base64 (~> 0.2) - colorator (~> 1.0) - csv (~> 3.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (>= 2.0, < 4.0) - jekyll-watch (~> 2.0) - json (~> 2.6) - kramdown (~> 2.3, >= 2.3.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (~> 0.3, >= 0.3.6) - pathutil (~> 0.9) - rouge (>= 3.0, < 5.0) - safe_yaml (~> 1.0) - terminal-table (>= 1.8, < 4.0) - webrick (~> 1.7) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - json (2.9.1) - just-the-docs (0.10.1) - jekyll (>= 3.8.5) - jekyll-include-cache - jekyll-seo-tag (>= 2.0) - rake (>= 12.3.1) - kramdown (2.5.1) - rexml (>= 3.3.9) - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.9.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (6.0.1) - rake (13.2.1) - rb-fsevent (0.11.2) - rb-inotify (0.11.1) - ffi (~> 1.0) - rexml (3.4.0) - rouge (4.5.1) - safe_yaml (1.0.5) - sass-embedded (1.83.4-arm64-darwin) - google-protobuf (~> 4.29) - sass-embedded (1.83.4-x86_64-linux-gnu) - google-protobuf (~> 4.29) - terminal-table (3.0.2) - unicode-display_width (>= 1.1.1, < 3) - unicode-display_width (2.6.0) - webrick (1.9.1) - -PLATFORMS - arm64-darwin - x86_64-linux-gnu - -DEPENDENCIES - jekyll (~> 4.4.1) - just-the-docs (= 0.10.1) - -BUNDLED WITH - 2.5.9 diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index b25f72e..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,190 +0,0 @@ -title: BetterLyrics Docs -description: BetterLyrics Docs -theme: just-the-docs - -url: https://jayfunc.github.io/BetterLyrics - -permalink: pretty - -defaults: - - scope: - path: "docs" # an empty string here means all files in the project - type: "pages" - values: - layout: "default" - -exclude: - # from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml: - - .sass-cache/ - - .jekyll-cache/ - - gemfiles/ - - Gemfile - - Gemfile.lock - - node_modules/ - - vendor/bundle/ - - vendor/cache/ - - vendor/gems/ - - vendor/ruby/ - # specific to the theme website: - - bin/ - - lib/ - - "*.gemspec" - - "*.gem" - - LICENSE.txt - - package.json - - package-lock.json - - Rakefile - - README.md - - CODE_OF_CONDUCT.md - - docker-compose.yml - - Dockerfile - # theme test code - - fixtures/ - -# Set a path/url to a logo that will be displayed instead of the title -#logo: "/assets/images/just-the-docs.png" - -# Enable or disable the site search -# Supports true (default) or false -search_enabled: true -search: - # Split pages into sections that can be searched individually - # Supports 1 - 6, default: 2 - heading_level: 2 - # Maximum amount of previews per search result - # Default: 3 - previews: 2 - # Maximum amount of words to display before a matched word in the preview - # Default: 5 - preview_words_before: 3 - # Maximum amount of words to display after a matched word in the preview - # Default: 10 - preview_words_after: 3 - # Set the search token separator - # Default: /[\s\-/]+/ - # Example: enable support for hyphenated search words - tokenizer_separator: /[\s/]+/ - # Display the relative url in search results - # Supports true (default) or false - rel_url: true - # Enable or disable the search button that appears in the bottom right corner of every page - # Supports true or false (default) - button: false - # Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS) - focus_shortcut_key: "k" - -# For copy button on code -enable_copy_code_button: true - -# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in -mermaid: - # Version of mermaid library - # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ - version: "9.1.6" - # Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js - # See also docs/ui-components/code - # To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g. - # for (v10+): - # path: "/assets/js/mermaid.esm.min.mjs" - # for (MIT license. This site is powered by Netlify.' - -# Footer last edited timestamp -last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter -last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html - -# Footer "Edit this page on GitHub" link text -gh_edit_link: true # show or hide edit this page link -gh_edit_link_text: "Edit this page on GitHub" -gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo -gh_edit_branch: "main" # the branch that your docs is served from -# gh_edit_source: docs # the source that your files originate from -gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately - -# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define -color_scheme: nil - -callouts_level: quiet # or loud -callouts: - highlight: - color: yellow - important: - title: Important - color: blue - new: - title: New - color: green - note: - title: Note - color: purple - warning: - title: Warning - color: red - -# Google Analytics Tracking (optional) -# Supports a CSV of tracking ID strings (eg. "UA-1234567-89,G-1AB234CDE5") -# Note: the main Just the Docs site does *not* use Google Analytics. -# ga_tracking: UA-2709176-10,G-5FG1HLH3XQ -# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default) - -plugins: - - jekyll-seo-tag - - jekyll-github-metadata - - jekyll-include-cache - - jekyll-sitemap - -kramdown: - syntax_highlighter_opts: - block: - line_numbers: false - -compress_html: - clippings: all - comments: all - endings: all - startings: [] - blanklines: false - profile: false - # ignore: - # envs: all \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index bd5bae4..0000000 --- a/docs/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: Home -layout: home -nav_order: 1 ---- - ---- - -[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). - -[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ -[GitHub Pages]: https://docs.github.com/en/pages -[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md -[Jekyll]: https://jekyllrb.com -[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ -[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate