diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index e77d767..0000000 --- a/.github/workflows/pages.yml +++ /dev/null @@ -1,62 +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: ["unified-docs-page"] - - # 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 - steps: - - name: Checkout - uses: actions/checkout@v3 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.1' # Not needed with a .ruby-version file - bundler-cache: true # runs 'bundle install' and caches installed gems automatically - cache-version: 0 # Increment this number if you need to re-download cached gems - - name: Setup Pages - id: pages - uses: actions/configure-pages@v3 - - 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 - # Automatically uploads an artifact from the './_site' directory by default - uses: actions/upload-pages-artifact@v1 - - # 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@v2 \ No newline at end of file diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 0861561..0000000 --- a/Gemfile +++ /dev/null @@ -1,8 +0,0 @@ -source 'https://rubygems.org' - -gem "jekyll" -gem "jekyll-default-layout" -gem "jekyll-github-metadata" -gem "jekyll-seo-tag" - -gem "just-the-docs" # always download the latest release \ No newline at end of file diff --git a/_config.yml b/_config.yml index 055bfc9..f87332f 100644 --- a/_config.yml +++ b/_config.yml @@ -1,141 +1,3 @@ -remote_theme: pmarsceill/just-the-docs -title: Kamaji Documentation -description: A Jekyll theme for documentation -repository: ISSUIUC/ISS_HILSIM # for github-metadata - -permalink: pretty - -# 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 - -# 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 - - - -gh_edit_link: false # show or hide edit this page link -gh_edit_link_text: "Edit this page on GitHub" -gh_edit_repository: "https://github.com/ISSUIUC/ISS_HILSIM" # 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-default-layout - -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 +title: Kamaji Docs +description: The documentation site for Kamaji, the ISS Hardware-in-the-loop simulator. +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/index.md b/index.md deleted file mode 100644 index 509d745..0000000 --- a/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# test indexmd - -Indexmd \ No newline at end of file