mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-08 04:51:23 -06:00
rename master -> main
This commit is contained in:
parent
7631aaa309
commit
13298d20c0
36
.github/release-drafter.yml
vendored
36
.github/release-drafter.yml
vendored
@ -1,33 +1,33 @@
|
|||||||
references:
|
references:
|
||||||
- v+
|
- v+
|
||||||
- master
|
- main
|
||||||
name-template: 'v$RESOLVED_VERSION 🌈'
|
name-template: "v$RESOLVED_VERSION 🌈"
|
||||||
tag-template: 'v$RESOLVED_VERSION'
|
tag-template: "v$RESOLVED_VERSION"
|
||||||
categories:
|
categories:
|
||||||
- title: '🚀 Features'
|
- title: "🚀 Features"
|
||||||
labels:
|
labels:
|
||||||
- 'feature'
|
- "feature"
|
||||||
- 'enhancement'
|
- "enhancement"
|
||||||
- title: '🐛 Bug Fixes'
|
- title: "🐛 Bug Fixes"
|
||||||
labels:
|
labels:
|
||||||
- 'fix'
|
- "fix"
|
||||||
- 'bugfix'
|
- "bugfix"
|
||||||
- 'bug'
|
- "bug"
|
||||||
- title: '🧰 Maintenance'
|
- title: "🧰 Maintenance"
|
||||||
label:
|
label:
|
||||||
- 'chore'
|
- "chore"
|
||||||
- 'dependencies'
|
- "dependencies"
|
||||||
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
|
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
|
||||||
version-resolver:
|
version-resolver:
|
||||||
major:
|
major:
|
||||||
labels:
|
labels:
|
||||||
- 'next-major-release'
|
- "next-major-release"
|
||||||
minor:
|
minor:
|
||||||
labels:
|
labels:
|
||||||
- 'next-minor-release'
|
- "next-minor-release"
|
||||||
patch:
|
patch:
|
||||||
labels:
|
labels:
|
||||||
- 'patch'
|
- "patch"
|
||||||
default: minor
|
default: minor
|
||||||
template: |
|
template: |
|
||||||
## Changes
|
## Changes
|
||||||
|
47
.github/workflows/ci-master.yml
vendored
47
.github/workflows/ci-master.yml
vendored
@ -1,45 +1,42 @@
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- main
|
||||||
|
|
||||||
name: Master branch CI
|
name: main branch CI
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
jekyll-latest:
|
jekyll-latest:
|
||||||
name: Build Jekyll site (latest)
|
name: Build Jekyll site (latest)
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- uses: actions/checkout@main
|
||||||
|
|
||||||
- uses: actions/checkout@master
|
- name: Build the site in the jekyll/builder container
|
||||||
|
run: |
|
||||||
- name: Build the site in the jekyll/builder container
|
docker run --rm \
|
||||||
run: |
|
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||||
docker run --rm \
|
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"
|
||||||
--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:
|
jekyll-3-8-5:
|
||||||
name: Build Jekyll site (v3.8.5)
|
name: Build Jekyll site (v3.8.5)
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- uses: actions/checkout@main
|
||||||
|
|
||||||
- uses: actions/checkout@master
|
- name: Build the site in the jekyll/builder container
|
||||||
|
run: |
|
||||||
- name: Build the site in the jekyll/builder container
|
docker run --rm \
|
||||||
run: |
|
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||||
docker run --rm \
|
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"
|
||||||
--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:
|
assets:
|
||||||
name: Format and test CSS and JS
|
name: Format and test CSS and JS
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- name: Use Node.js 12.x
|
- name: Use Node.js 12.x
|
||||||
uses: actions/setup-node@v1
|
uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
node-version: '12.x'
|
node-version: "12.x"
|
||||||
- run: npm install
|
- run: npm install
|
||||||
- run: npm test
|
- run: npm test
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
<p align="right">
|
<p align="right">
|
||||||
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/just-the-docs/just-the-docs/actions?query=workflow%3A%22Master+branch+CI%22"><img src="https://github.com/just-the-docs/just-the-docs/workflows/Master%20branch%20CI/badge.svg" alt="Build status"></a>
|
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/just-the-docs/just-the-docs/actions?query=workflow%3A%22main+branch+CI%22"><img src="https://github.com/just-the-docs/just-the-docs/workflows/main%20branch%20CI/badge.svg" alt="Build status"></a>
|
||||||
</p>
|
</p>
|
||||||
<br><br>
|
<br><br>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
@ -81,7 +81,7 @@ nav_sort: case_sensitive # Capital letters sorted before lowercase
|
|||||||
back_to_top: true
|
back_to_top: true
|
||||||
back_to_top_text: "Back to top"
|
back_to_top_text: "Back to top"
|
||||||
|
|
||||||
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
|
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
|
||||||
|
|
||||||
# Footer last edited timestamp
|
# 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_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: true # show or hide edit this page link
|
||||||
gh_edit_link_text: "Edit this page on GitHub"
|
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_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_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
|
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ Just the Docs has some specific configuration parameters that can be defined in
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
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
|
## Site logo
|
||||||
|
|
||||||
@ -90,7 +90,7 @@ heading_anchors: true
|
|||||||
# appears at the bottom of every page's main content
|
# 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
|
# 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.
|
markup / liquid-based content.
|
||||||
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
|
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
|
||||||
|
|
||||||
# Footer last edited timestamp
|
# 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_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
||||||
@ -100,7 +100,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: true # show or hide edit this page link
|
||||||
gh_edit_link_text: "Edit this page on GitHub."
|
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_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_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
|
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||||
```
|
```
|
||||||
@ -110,7 +110,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
|
- 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)
|
- `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_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_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
|
- `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
|
||||||
|
|
||||||
|
@ -61,7 +61,7 @@ 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)
|
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.
|
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:
|
For example, to change the link color from the purple default to blue, include the following inside your scheme file:
|
||||||
|
|
||||||
@ -89,9 +89,10 @@ color_scheme: foo
|
|||||||
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)
|
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 %}
|
## {% raw %}
|
||||||
---
|
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
|
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
|
@ -5,13 +5,15 @@ nav_order: 7
|
|||||||
---
|
---
|
||||||
|
|
||||||
# Search
|
# Search
|
||||||
|
|
||||||
{: .no_toc }
|
{: .no_toc }
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
{: .no_toc .text-delta }
|
{: .no_toc .text-delta }
|
||||||
|
|
||||||
1. TOC
|
1. TOC
|
||||||
{:toc}
|
{:toc}
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -76,7 +78,7 @@ To allow search for hyphenated words:
|
|||||||
search.tokenizer_separator: /[\s/]+/
|
search.tokenizer_separator: /[\s/]+/
|
||||||
```
|
```
|
||||||
|
|
||||||
### Display URL in search results
|
### Display URL in search results
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Display the relative url in search results
|
# 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
|
search.button: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Hiding pages from search
|
## 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.
|
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:
|
To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter:
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
{: .no_toc }
|
{: .no_toc }
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -110,8 +112,8 @@ title: Page not found
|
|||||||
nav_exclude: true
|
nav_exclude: true
|
||||||
search_exclude: true
|
search_exclude: true
|
||||||
---
|
---
|
||||||
```
|
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Generate search index when used as a gem
|
## 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.
|
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).
|
||||||
|
4
index.md
4
index.md
@ -85,7 +85,7 @@ Just the Docs is © 2017-{{ "now" | date: "%Y" }} by [Patrick Marsceill](htt
|
|||||||
|
|
||||||
### License
|
### 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
|
### Contributing
|
||||||
|
|
||||||
@ -106,4 +106,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.
|
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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user