Skip to content

Tangy Mkdocs Build Action

Actions
Builds documentation using Mkdocs and deploys to GitHub pages
v1
Latest
Star (0)

tangy-mkdocs-build-action

This GitHub Action will compile your MkDocs site and Deploy it to GitHub Pages using one of the default themes. It assumes that you have a mkdocs.yml file a in the top-level directory of your project and that the documentation source files (in Markdown format) are stored within the docs/ directory.

GitHub Action for building the Tangerine Documentation with Mkdocs and publish to GitHub Pages

Example Action Workflow for your Repo

name: Build Documentation using MkDocs

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  push:
    branches: [master]
  pull_request:
    branches: [master]

jobs:
  build:
    name: Build and Deploy Documentation
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Master
        uses: actions/checkout@v2

      - name: Build and Deploy Documentation using MkDocs
        uses: Tangerine-Community/tangy-mkdocs-build-action@v1

Tangy Mkdocs Build Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Builds documentation using Mkdocs and deploys to GitHub pages
v1
Latest

Tangy Mkdocs Build Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.