diff --git a/.gitignore b/.gitignore index 504afef..5d49557 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules/ package-lock.json +.vscode/ diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..918de83 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,6 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor +Gemfile.lock diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 0000000..80568aa --- /dev/null +++ b/docs/404.md @@ -0,0 +1,8 @@ +--- +permalink: /404.html +nav_exclude: true +--- + +# 404 + +The requested page could not be found. diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..ca30fde --- /dev/null +++ b/docs/Gemfile @@ -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 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..a3b20a7 --- /dev/null +++ b/docs/_config.yml @@ -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 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e4d427d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +--- +layout: home +---