diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index bdfde2a..6a1034e 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,33 +1,33 @@ references: - v+ - - master -name-template: 'v$RESOLVED_VERSION 🌈' -tag-template: 'v$RESOLVED_VERSION' + - main +name-template: "v$RESOLVED_VERSION 🌈" +tag-template: "v$RESOLVED_VERSION" categories: - - title: '🚀 Features' + - title: "🚀 Features" labels: - - 'feature' - - 'enhancement' - - title: '🐛 Bug Fixes' + - "feature" + - "enhancement" + - title: "🐛 Bug Fixes" labels: - - 'fix' - - 'bugfix' - - 'bug' - - title: '🧰 Maintenance' - label: - - 'chore' - - 'dependencies' -change-template: '- $TITLE @$AUTHOR (#$NUMBER)' + - "fix" + - "bugfix" + - "bug" + - title: "🧰 Maintenance" + label: + - "chore" + - "dependencies" +change-template: "- $TITLE @$AUTHOR (#$NUMBER)" version-resolver: major: labels: - - 'next-major-release' + - "next-major-release" minor: labels: - - 'next-minor-release' + - "next-minor-release" patch: labels: - - 'patch' + - "patch" default: minor template: | ## Changes diff --git a/.github/workflows/ci-master.yml b/.github/workflows/ci-master.yml index 6d41eb5..4f970d4 100644 --- a/.github/workflows/ci-master.yml +++ b/.github/workflows/ci-master.yml @@ -1,45 +1,42 @@ -on: +on: push: branches: - - master + - main -name: Master branch CI +name: main branch CI jobs: - jekyll-latest: name: Build Jekyll site (latest) runs-on: ubuntu-latest steps: + - uses: actions/checkout@main - - uses: actions/checkout@master - - - name: Build the site in the jekyll/builder container - run: | - docker run --rm \ - --volume="${{ github.workspace }}:/srv/jekyll" \ - jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init" + - name: Build the site in the jekyll/builder container + run: | + docker run --rm \ + --volume="${{ github.workspace }}:/srv/jekyll" \ + jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init" jekyll-3-8-5: name: Build Jekyll site (v3.8.5) runs-on: ubuntu-latest steps: + - uses: actions/checkout@main - - uses: actions/checkout@master - - - name: Build the site in the jekyll/builder container - run: | - docker run --rm \ - --volume="${{ github.workspace }}:/srv/jekyll" \ - jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init" + - name: Build the site in the jekyll/builder container + run: | + docker run --rm \ + --volume="${{ github.workspace }}:/srv/jekyll" \ + jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init" assets: name: Format and test CSS and JS runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Use Node.js 12.x - uses: actions/setup-node@v1 - with: - node-version: '12.x' - - run: npm install - - run: npm test + - uses: actions/checkout@v2 + - name: Use Node.js 12.x + uses: actions/setup-node@v1 + with: + node-version: "12.x" + - run: npm install + - run: npm test diff --git a/.prettierignore b/.prettierignore index 5dc073f..692aa34 100644 --- a/.prettierignore +++ b/.prettierignore @@ -7,3 +7,4 @@ assets/css/just-the-docs-dark.scss assets/js/vendor/lunr.min.js assets/js/search-data.json assets/js/just-the-docs.js +*.md diff --git a/.prettierrc b/.prettierrc index 284e842..70175ce 100644 --- a/.prettierrc +++ b/.prettierrc @@ -4,5 +4,4 @@ "singleQuote": false, "tabWidth": 2, "trailingComma": "es5" -} - +} \ No newline at end of file diff --git a/README.md b/README.md index c0dc5fa..16b6ab2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

- Gem version Build status + Gem version Build status



Just the Docs

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

-

See it in action!

+

See it in action!




@@ -39,7 +39,7 @@ Alternatively, you can run it inside Docker while developing your site ## Usage -[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information. +[View the documentation](https://just-the-docs.github.io/just-the-docs/) for usage information. ## Contributing diff --git a/_config.yml b/_config.yml index 902093a..dbe742f 100644 --- a/_config.yml +++ b/_config.yml @@ -16,7 +16,7 @@ title: Just the Docs description: A Jekyll theme for documentation baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog -url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com +url: "https://just-the-docs.github.io" # the base hostname & protocol for your site, e.g. http://example.com permalink: pretty exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile" @@ -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 @@ -93,7 +93,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/ 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: "master" # the branch that your docs is served from +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 diff --git a/docs/configuration.md b/docs/configuration.md index d3737d5..b11f448 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,22 +5,20 @@ nav_order: 2 --- # Configuration - {: .no_toc } 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/just-the-docs/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/main/_config.yml) file as an example. ## Site logo @@ -90,7 +88,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 +98,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/ 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: "master" # the branch that your docs is served from +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 ``` @@ -110,7 +108,7 @@ _note: `footer_content` is deprecated, but still supported. For a better experie - the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format - `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime) - `gh_edit_repository` is the URL of the project's GitHub repository -- `gh_edit_branch` is the branch that the docs site is served from; defaults to `master` +- `gh_edit_branch` is the branch that the docs site is served from; defaults to `main` - `gh_edit_source` is the source directory that your project files are stored in (should be the same as [site.source](https://jekyllrb.com/docs/configuration/options/)) - `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode diff --git a/docs/customization.md b/docs/customization.md index 816903c..075e30d 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -5,15 +5,13 @@ nav_order: 6 --- # Customization - {: .no_toc } ## Table of contents - {: .no_toc .text-delta } 1. TOC - {:toc} +{:toc} --- @@ -29,7 +27,6 @@ Just the Docs supports two color schemes: light (default), and dark. To enable a color scheme, set the `color_scheme` parameter in your site's `_config.yml` file: #### Example - {: .no_toc } ```yaml @@ -61,12 +58,11 @@ You can add custom schemes. If you want to add a scheme named `foo` (can be any name) just add a file `_sass/color_schemes/foo.scss` (replace `foo` by your scheme name) where you override theme variables to change colors, fonts, spacing, etc. -Available variables are listed in the [\_variables.scss](https://github.com/just-the-docs/just-the-docs/tree/master/_sass/support/_variables.scss) file. +Available variables are listed in the [\_variables.scss](https://github.com/just-the-docs/just-the-docs/tree/main/_sass/support/_variables.scss) file. For example, to change the link color from the purple default to blue, include the following inside your scheme file: #### Example - {: .no_toc } ```scss @@ -87,12 +83,12 @@ color_scheme: foo ### Switchable custom scheme If you want to be able to change the scheme dynamically, for example via javascript, just add a file `assets/css/just-the-docs-foo.scss` (replace `foo` by your scheme name) -with the following content:` +with the following content: {% raw %} ---- ---- -{% include css/just-the-docs.scss.liquid color_scheme="foo" %} + --- + --- + {% include css/just-the-docs.scss.liquid color_scheme="foo" %} {% endraw %} This allows you to switch the scheme via the following javascript. @@ -111,7 +107,6 @@ This will allow for all overrides to be kept in a single file, and for any upstr For example, if you'd like to add your own styles for printing a page, you could add the following styles. #### Example - {: .no_toc } ```scss diff --git a/docs/search.md b/docs/search.md index 495884d..69bd106 100644 --- a/docs/search.md +++ b/docs/search.md @@ -5,13 +5,15 @@ nav_order: 7 --- # Search + {: .no_toc } ## Table of contents + {: .no_toc .text-delta } 1. TOC -{:toc} + {:toc} --- @@ -76,7 +78,7 @@ To allow search for hyphenated words: search.tokenizer_separator: /[\s/]+/ ``` -### Display URL in search results +### Display URL in search results ```yaml # Display the relative url in search results @@ -94,13 +96,13 @@ The search button displays in the bottom right corner of the screen and triggers search.button: true ``` - ## Hiding pages from search Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page. To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter: #### Example + {: .no_toc } ```yaml @@ -110,8 +112,8 @@ title: Page not found nav_exclude: true search_exclude: true --- -``` +``` ## Generate search index when used as a gem @@ -124,4 +126,4 @@ $ bundle exec just-the-docs rake search:init ``` This command creates the `assets/js/zzzz-search-data.json` file that Jekyll uses to create your search index. -Alternatively, you can create the file manually with [this content]({{ site.github.repository_url }}/blob/master/assets/js/zzzz-search-data.json). +Alternatively, you can create the file manually with [this content]({{ site.github.repository_url }}/blob/main/assets/js/zzzz-search-data.json). diff --git a/index.md b/index.md index c527bf1..c8e688f 100644 --- a/index.md +++ b/index.md @@ -6,8 +6,7 @@ description: "Just the Docs is a responsive Jekyll theme with built-in search th permalink: / --- -# Focus on writing good documentation - +# Focus on writing good documentation. {: .fs-9 } Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages. @@ -85,7 +84,7 @@ Just the Docs is © 2017-{{ "now" | date: "%Y" }} by [Patrick Marsceill](htt ### License -Just the Docs is distributed by an [MIT license](https://github.com/just-the-docs/just-the-docs/tree/master/LICENSE.txt). +Just the Docs is distributed by an [MIT license](https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt). ### Contributing @@ -106,4 +105,4 @@ email, or any other method with the owners of this repository before making a ch Just the Docs is committed to fostering a welcoming community. -[View our Code of Conduct](https://github.com/just-the-docs/just-the-docs/tree/master/CODE_OF_CONDUCT.md) on our GitHub repository. +[View our Code of Conduct](https://github.com/just-the-docs/just-the-docs/tree/main/CODE_OF_CONDUCT.md) on our GitHub repository.