Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation to a Jekyll site #8

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules/
package-lock.json
.vscode/
6 changes: 6 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
Gemfile.lock
8 changes: 8 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
permalink: /404.html
nav_exclude: true
---

# 404

The requested page could not be found.
10 changes: 10 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
source "https://rubygems.org"

gem "just-the-docs"
gem "jekyll", "~> 4", group: :jekyll_plugins

group :jekyll_plugins do
gem "jekyll-default-layout"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
end
29 changes: 29 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
title: PR Preview Action
tagline: A GitHub Action for previewing pull requests
description: >-
Documentation for PR Preview Action, a GitHub Action that deploys pull
request previews to GitHub Pages (and removes them after merge).
baseurl: ""
url: https://rossjrw.com/

permalink: pretty

author:
url: https://rossjrw.com/

theme: just-the-docs

aux_links:
GitHub:
- "https://github.com/rossjrw/pr-preview-action"

gh_edit_link: true
gh_edit_link_text: Edit this page on GitHub
gh_edit_repository: https://github.com/rossjrw/pr-preview-action
gh_edit_branch: main
gh_edit_source: docs

ga_tracking: G-19V908BQMY

plugins:
- jekyll-seo-tag
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: home
---
Loading