From 4ab61105b9e3d11d1d3ce506fc8413f7f1c0a5b0 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Wed, 14 Oct 2020 13:17:51 -0400 Subject: [PATCH 1/7] Create publish-gem.yml --- .github/workflows/publish-gem.yml | 39 +++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/publish-gem.yml diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml new file mode 100644 index 0000000000..dab93ae5cc --- /dev/null +++ b/.github/workflows/publish-gem.yml @@ -0,0 +1,39 @@ +name: Ruby Gem + +on: + workflow_dispatch + +jobs: + build: + name: Publish + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Ruby 2.6 + uses: actions/setup-ruby@v1 + with: + ruby-version: 2.6.x + + - name: Publish to GPR + run: | + mkdir -p $HOME/.gem + touch $HOME/.gem/credentials + chmod 0600 $HOME/.gem/credentials + printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials + gem build *.gemspec + gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem + env: + GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}" + OWNER: ${{ github.repository_owner }} + + - name: Publish to RubyGems + run: | + mkdir -p $HOME/.gem + touch $HOME/.gem/credentials + chmod 0600 $HOME/.gem/credentials + printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials + gem build *.gemspec + gem push *.gem + env: + GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}" From 8bc53f8f45ce6a11be0559c764d39d90f2434ec1 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Wed, 14 Oct 2020 13:20:46 -0400 Subject: [PATCH 2/7] Bump gem spec --- just-the-docs.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/just-the-docs.gemspec b/just-the-docs.gemspec index 0c4d3a303a..6d467e23e2 100644 --- a/just-the-docs.gemspec +++ b/just-the-docs.gemspec @@ -2,7 +2,7 @@ Gem::Specification.new do |spec| spec.name = "just-the-docs" - spec.version = "0.3.2" + spec.version = "0.3.3" spec.authors = ["Patrick Marsceill"] spec.email = ["patrick.marsceill@gmail.com"] From cb7df09c8f96a2fae29991632b0810ea0cb8adc7 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Wed, 14 Oct 2020 13:21:02 -0400 Subject: [PATCH 3/7] Update package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index edc08010a9..0f5820439d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "just-the-docs", - "version": "0.3.2", + "version": "0.3.3", "description": "A modern Jekyll theme for documentation", "repository": "pmarsceill/just-the-docs", "license": "MIT", From 7f5ebee9b8c418136889f142f5ee54836651fb4b Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Wed, 14 Oct 2020 13:22:34 -0400 Subject: [PATCH 4/7] Delete publish.yml --- .github/workflows/publish.yml | 39 ----------------------------------- 1 file changed, 39 deletions(-) delete mode 100644 .github/workflows/publish.yml diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index bba33db1b4..0000000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Publish Gem - -on: [release] - -jobs: - build: - name: Build + Publish - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@master - - name: Set up Ruby 2.6 - uses: actions/setup-ruby@v1 - with: - version: 2.6.x - - - name: Publish to GPR - run: | - mkdir -p $HOME/.gem - touch $HOME/.gem/credentials - chmod 0600 $HOME/.gem/credentials - printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials - gem build just-the-docs.gemspec - gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem - env: - GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}} - OWNER: pmarsceill - - - name: Publish to RubyGems - run: | - mkdir -p $HOME/.gem - touch $HOME/.gem/credentials - chmod 0600 $HOME/.gem/credentials - printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials - gem build just-the-docs.gemspec - gem push *.gem - env: - GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}} - From e8424986370bef104e680e1443a83e475d2fead7 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Wed, 14 Oct 2020 13:23:05 -0400 Subject: [PATCH 5/7] Update publish-gem.yml --- .github/workflows/publish-gem.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index dab93ae5cc..3f1943ea28 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -1,4 +1,4 @@ -name: Ruby Gem +name: Publish Ruby Gem on: workflow_dispatch From 2aa98150640b41c2e42039748479568e48bbd050 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Thu, 3 Mar 2022 18:50:33 +0000 Subject: [PATCH 6/7] Update to new repo path --- .github/ISSUE_TEMPLATE/config.yml | 2 +- README.md | 6 +++--- _config.yml | 6 +++--- _layouts/default.html | 2 +- docs/configuration.md | 21 ++++++++++---------- docs/customization.md | 32 +++++++++++++++++++++--------- docs/navigation-structure.md | 33 +++++++++++++++++++++++++------ index.md | 23 ++++++++++++++++----- just-the-docs.gemspec | 2 +- package-lock.json | 2 +- package.json | 4 ++-- 11 files changed, 91 insertions(+), 42 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8efd188d4c..fd77ad0a8f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Ask a question - url: https://github.com/pmarsceill/just-the-docs/discussions + url: https://github.com/just-the-docs/just-the-docs/discussions about: Ask questions and discuss with other community members diff --git a/README.md b/README.md index 4d1c1e889f..c0dc5faf42 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Gem version Build status + Gem version Build status



@@ -43,11 +43,11 @@ Alternatively, you can run it inside Docker while developing your site ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/just-the-docs/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ### Submitting code changes: -- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls) +- Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls) - Ensure all CI tests pass - Await code review - Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/). diff --git a/_config.yml b/_config.yml index ad42809851..902093ab96 100644 --- a/_config.yml +++ b/_config.yml @@ -65,7 +65,7 @@ heading_anchors: true # Aux links for the upper right navigation aux_links: "Just the Docs on GitHub": - - "//github.com/pmarsceill/just-the-docs" + - "//github.com/just-the-docs/just-the-docs" # Makes Aux links open in a new tab. Default is false aux_links_new_tab: false @@ -81,7 +81,7 @@ nav_sort: case_sensitive # Capital letters sorted before lowercase back_to_top: true back_to_top_text: "Back to top" -footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an MIT license." +footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an MIT license." # Footer last edited timestamp last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter @@ -92,7 +92,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/ # 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/pmarsceill/just-the-docs" # the github URL for your repo +gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo gh_edit_branch: "master" # 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 diff --git a/_layouts/default.html b/_layouts/default.html index f571923c09..40d85ace46 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -66,7 +66,7 @@ {% endif %}

- This site uses Just the Docs, a documentation theme for Jekyll. + This site uses Just the Docs, a documentation theme for Jekyll.
diff --git a/docs/configuration.md b/docs/configuration.md index 7b21bfab75..d3737d576a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,23 +5,22 @@ nav_order: 2 --- # Configuration -{: .no_toc } +{: .no_toc } -Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's _config.yml file. +Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's \_config.yml file. {: .fs-6 .fw-300 } ## Table of contents + {: .no_toc .text-delta } 1. TOC -{:toc} + {:toc} --- - -View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example. - +View this site's [\_config.yml](https://github.com/just-the-docs/just-the-docs/tree/master/_config.yml) file as an example. ## Site logo @@ -68,7 +67,7 @@ search: # Aux links for the upper right navigation aux_links: "Just the Docs on GitHub": - - "//github.com/pmarsceill/just-the-docs" + - "//github.com/just-the-docs/just-the-docs" # Makes Aux links open in a new tab. Default is false aux_links_new_tab: false @@ -91,7 +90,7 @@ heading_anchors: true # appears at the bottom of every page's main content # Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust markup / liquid-based content. -footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an MIT license." +footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an MIT license." # Footer last edited timestamp last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter @@ -100,7 +99,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/ # 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/pmarsceill/just-the-docs" # the github URL for your repo +gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo gh_edit_branch: "master" # 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 @@ -121,6 +120,7 @@ _note: `footer_content` is deprecated, but still supported. For a better experie # Color scheme supports "light" (default) and "dark" color_scheme: dark ``` +