mirror of
https://github.com/fallenbagel/jellyseerr.git
synced 2025-12-24 02:39:18 -05:00
docs: setup docusaurus for documentation (#848)
* docs: setup docusaurus for documentation * docs: setup tailwind content for docusaurus * chore: ensure tailwindcss is installed so pages deploy works * docs: add cname to point to docs * ci: override format checking for pnpm-lock in gen-docs folder * docs(gen-docs): readme for docusaurus * chore(gen-docs): remove unnecessary image files * docs: remove installation instructions (moved to docs) * ci: rename docusaurus workflows to a more explicit name * style(gen-docs): custom color for links * docs: add more doc pages * style: gradient menu link bg, proper jellyseerr font & footer bg color * docs: fix proper link to relative pages * style: tab-items also now uses the proper jellyseerr colors * style: use prismTheme shadesOfPurple for codeblock/syntax highlighting * docs: fix broken links * docs: fix broken links * docs: fix broken anchors * chore(gen-docs): local search bar * style(gen-docs): tab colors * docs: reverse-proxy documentation * style(gen-docs): jellyseerr-like cards * docs: rename baremetal to build from source * docs: nixpkg version check component * docs: conditionally render override package derivation block and admonitions * docs: users section of the documentation
This commit is contained in:
51
.github/workflows/test-docs-deploy.yml
vendored
Normal file
51
.github/workflows/test-docs-deploy.yml
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
name: Test Docs deployment
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- develop
|
||||
path:
|
||||
- 'docs/**'
|
||||
- 'gen-docs/**'
|
||||
|
||||
jobs:
|
||||
test-deploy:
|
||||
name: Test deployment
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
|
||||
- name: Pnpm Setup
|
||||
uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 9
|
||||
|
||||
- name: Get pnpm store directory
|
||||
shell: sh
|
||||
run: |
|
||||
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||
|
||||
- name: Setup pnpm cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ${{ env.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
cd gen-docs
|
||||
pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build website
|
||||
run: |
|
||||
cd gen-docs
|
||||
pnpm build
|
||||
Reference in New Issue
Block a user