mirror of
https://github.com/remoteintech/remote-jobs
synced 2025-01-12 12:38:43 +00:00
start the move to Jekyll and use Just the Docs
This commit is contained in:
parent
c5e9e40236
commit
ee9f3fe0f0
5 changed files with 326 additions and 0 deletions
51
.github/workflows/jekyll-gh-pages.yml
vendored
Normal file
51
.github/workflows/jekyll-gh-pages.yml
vendored
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
|
||||||
|
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
|
||||||
|
|
||||||
|
on:
|
||||||
|
# Runs on pushes targeting the default branch
|
||||||
|
push:
|
||||||
|
branches: ["main"]
|
||||||
|
|
||||||
|
# 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
||||||
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
||||||
|
concurrency:
|
||||||
|
group: "pages"
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Build job
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: Setup Pages
|
||||||
|
uses: actions/configure-pages@v3
|
||||||
|
- name: Build with Jekyll
|
||||||
|
uses: actions/jekyll-build-pages@v1
|
||||||
|
with:
|
||||||
|
source: ./
|
||||||
|
destination: ./_site
|
||||||
|
- name: Upload artifact
|
||||||
|
uses: actions/upload-pages-artifact@v2
|
||||||
|
|
||||||
|
# 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
|
7
Gemfile
Normal file
7
Gemfile
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
source 'https://rubygems.org'
|
||||||
|
|
||||||
|
gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
|
||||||
|
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
|
||||||
|
|
||||||
|
# gem "just-the-docs", "0.6.2" # pinned to the current release
|
||||||
|
gem "just-the-docs" # always download the latest release
|
81
Gemfile.lock
Normal file
81
Gemfile.lock
Normal file
|
@ -0,0 +1,81 @@
|
||||||
|
GEM
|
||||||
|
remote: https://rubygems.org/
|
||||||
|
specs:
|
||||||
|
addressable (2.8.5)
|
||||||
|
public_suffix (>= 2.0.2, < 6.0)
|
||||||
|
colorator (1.1.0)
|
||||||
|
concurrent-ruby (1.2.2)
|
||||||
|
em-websocket (0.5.3)
|
||||||
|
eventmachine (>= 0.12.9)
|
||||||
|
http_parser.rb (~> 0)
|
||||||
|
eventmachine (1.2.7)
|
||||||
|
ffi (1.15.5)
|
||||||
|
forwardable-extended (2.6.0)
|
||||||
|
google-protobuf (3.24.3-x86_64-linux)
|
||||||
|
http_parser.rb (0.8.0)
|
||||||
|
i18n (1.14.1)
|
||||||
|
concurrent-ruby (~> 1.0)
|
||||||
|
jekyll (4.3.2)
|
||||||
|
addressable (~> 2.4)
|
||||||
|
colorator (~> 1.0)
|
||||||
|
em-websocket (~> 0.5)
|
||||||
|
i18n (~> 1.0)
|
||||||
|
jekyll-sass-converter (>= 2.0, < 4.0)
|
||||||
|
jekyll-watch (~> 2.0)
|
||||||
|
kramdown (~> 2.3, >= 2.3.1)
|
||||||
|
kramdown-parser-gfm (~> 1.0)
|
||||||
|
liquid (~> 4.0)
|
||||||
|
mercenary (>= 0.3.6, < 0.5)
|
||||||
|
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)
|
||||||
|
just-the-docs (0.6.2)
|
||||||
|
jekyll (>= 3.8.5)
|
||||||
|
jekyll-include-cache
|
||||||
|
jekyll-seo-tag (>= 2.0)
|
||||||
|
rake (>= 12.3.1)
|
||||||
|
kramdown (2.4.0)
|
||||||
|
rexml
|
||||||
|
kramdown-parser-gfm (1.1.0)
|
||||||
|
kramdown (~> 2.0)
|
||||||
|
liquid (4.0.4)
|
||||||
|
listen (3.8.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 (5.0.3)
|
||||||
|
rake (13.0.6)
|
||||||
|
rb-fsevent (0.11.2)
|
||||||
|
rb-inotify (0.10.1)
|
||||||
|
ffi (~> 1.0)
|
||||||
|
rexml (3.2.6)
|
||||||
|
rouge (4.1.3)
|
||||||
|
safe_yaml (1.0.5)
|
||||||
|
sass-embedded (1.67.0-x86_64-linux-gnu)
|
||||||
|
google-protobuf (~> 3.23)
|
||||||
|
terminal-table (3.0.2)
|
||||||
|
unicode-display_width (>= 1.1.1, < 3)
|
||||||
|
unicode-display_width (2.4.2)
|
||||||
|
webrick (1.8.1)
|
||||||
|
|
||||||
|
PLATFORMS
|
||||||
|
x86_64-linux
|
||||||
|
|
||||||
|
DEPENDENCIES
|
||||||
|
jekyll (~> 4.3.2)
|
||||||
|
just-the-docs (= 0.6.2)
|
||||||
|
|
||||||
|
BUNDLED WITH
|
||||||
|
2.3.26
|
179
_config.yml
Normal file
179
_config.yml
Normal file
|
@ -0,0 +1,179 @@
|
||||||
|
# Welcome to Jekyll!
|
||||||
|
#
|
||||||
|
# This config file is meant for settings that affect your whole site, values
|
||||||
|
# which you are expected to set up once and rarely edit after that. If you find
|
||||||
|
# yourself editing these this file very often, consider using Jekyll's data files
|
||||||
|
# feature for the data you need to update frequently.
|
||||||
|
#
|
||||||
|
# For technical reasons, this file is *NOT* reloaded automatically when you use
|
||||||
|
# 'jekyll serve'. If you change this file, please restart the server process.
|
||||||
|
|
||||||
|
# Site settings
|
||||||
|
# These are used to personalize your new site. If you look in the HTML files,
|
||||||
|
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
|
||||||
|
# You can create any custom variable you would like, and they will be accessible
|
||||||
|
# in the templates via {{ site.myvariable }}.
|
||||||
|
title: Remote in Tech
|
||||||
|
description: A list of semi to fully remote-friendly companies in tech
|
||||||
|
baseurl: "" # the subpath of your site, e.g. /blog
|
||||||
|
url: "https://remoteintech.company" # the base hostname & protocol for your site, e.g. http://example.com
|
||||||
|
repository: remoteintech/remote-jobs # for github-metadata
|
||||||
|
|
||||||
|
permalink: pretty
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
# 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: "10.5.0"
|
||||||
|
# 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 (<v10):
|
||||||
|
# path: "/assets/js/mermaid.min.js"
|
||||||
|
# Note: copy both `mermaid.esm.min.mjs` (v10+) or `mermaid.min.js` (<v10) and the associated `.map` file from the specified version of `mermaid/dist` to `/assets/js/`.
|
||||||
|
|
||||||
|
# Enable or disable heading anchors
|
||||||
|
heading_anchors: true
|
||||||
|
|
||||||
|
# Aux links for the upper right navigation
|
||||||
|
aux_links:
|
||||||
|
"Interested in the source of this?":
|
||||||
|
- "https://github.com/remoteintech/remote-jobs"
|
||||||
|
|
||||||
|
# Makes Aux links open in a new tab. Default is false
|
||||||
|
aux_links_new_tab: false
|
||||||
|
|
||||||
|
# Sort order for navigation links
|
||||||
|
# nav_sort: case_insensitive # default, equivalent to nil
|
||||||
|
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||||
|
|
||||||
|
# External navigation links
|
||||||
|
nav_external_links:
|
||||||
|
- title: Nav - Interested in the source of this?
|
||||||
|
url: https://github.com/remoteintech/remote-jobs
|
||||||
|
|
||||||
|
# Footer content
|
||||||
|
# appears at the bottom of every page's main content
|
||||||
|
|
||||||
|
# Back to top link
|
||||||
|
back_to_top: true
|
||||||
|
back_to_top_text: "Back to top"
|
||||||
|
|
||||||
|
footer_content: "Powered by <a href=\"https://github.com/remoteintech/remote-jobs/graphs/contributors\">contributors.</a> <a href=\"https://github.com/dougaitken\">Maintained by Doug.</a>"
|
||||||
|
|
||||||
|
# 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/remoteintech/remote-jobs" # 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
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- jekyll-seo-tag
|
||||||
|
- jekyll-github-metadata
|
||||||
|
- jekyll-include-cache
|
||||||
|
|
||||||
|
kramdown:
|
||||||
|
syntax_highlighter_opts:
|
||||||
|
block:
|
||||||
|
line_numbers: false
|
||||||
|
|
||||||
|
compress_html:
|
||||||
|
clippings: all
|
||||||
|
comments: all
|
||||||
|
endings: all
|
||||||
|
startings: []
|
||||||
|
blanklines: false
|
||||||
|
profile: false
|
||||||
|
# ignore:
|
||||||
|
# envs: all
|
8
index.md
Normal file
8
index.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
title: Home
|
||||||
|
layout: home
|
||||||
|
---
|
||||||
|
|
||||||
|
Hello.
|
||||||
|
|
||||||
|
----
|
Loading…
Reference in a new issue