Docship

Build and deploy documentation sites to GitHub Pages with a single command.

Usage

Add to .github/workflows/deploy.yml:

name: Deploy

on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    uses: NekoTick/docship/.github/workflows/docusaurus.yml@main

Supported Frameworks

Framework	Workflow File	Features
Docsify	docsify.yml	Pure frontend, no build required
Docusaurus	docusaurus.yml	React-powered, feature-rich
Docus	docus.yml	Nuxt 4-powered, modern design
Docute	docute.yml	Pure frontend, Vue-based
DocFX	docfx.yml	.NET ecosystem
Eleventy	eleventy.yml	JavaScript, flexible templating
Fumadocs	fumadocs.yml	Next.js-powered
HonKit	honkit.yml	GitBook fork
Hugo	hugo-book.yml	Go-powered, Book theme
Jekyll	jekyll-just-the-docs.yml	Ruby ecosystem, Just the Docs theme
mdBook	mdbook.yml	Rust-powered, lightweight
MkDocs Material	mkdocs-material.yml	Python ecosystem, Material theme
Nextra	nextra.yml	Next.js-powered
Sphinx	sphinx.yml	Python ecosystem, Furo theme
Rspress	rspress.yml	Rspack-powered
Starlight	starlight.yml	Astro framework
VitePress	vitepress.yml	Vue-powered, fast
VuePress	vuepress.yml	Vue 2 ecosystem
Zensical	zensical.yml	Rust-powered, MkDocs compatible

Examples

Fumadocs (Next.js)

jobs:
  deploy:
    uses: NekoTick/docship/.github/workflows/fumadocs.yml@main

VitePress

jobs:
  deploy:
    uses: NekoTick/docship/.github/workflows/vitepress.yml@main

Docsify

jobs:
  deploy:
    uses: NekoTick/docship/.github/workflows/docsify.yml@main

Zensical

jobs:
  deploy:
    uses: NekoTick/docship/.github/workflows/zensical.yml@main