Add project: markdown-docs is a GitHub Actions based on MkDocs

[ldeluigi]

Project details:
ldeluigi/markdown-docs is my GitHub Action powered by mkdocs and mkdocs-material to allow straightforward usage and integration of mkdocs with GitHub Actions.
The rationale is zero-configuration-needed, you specify a folder as source of markdown files and another folder as destination, and it works just fine like that. Optionally someone can use the same action with some customization.

The action also implies support of some markdown extensions (see readme), and is also published as a Docker image on Docker Hub so that it can be used in other CI providers.

• Project Name: markdown-docs
• Github URL: https://github.com/ldeluigi/markdown-docs
• Category: idk maybe a new one called something like "Automation Machinery" or Other
• License: MIT
• Package Managers: github-actions:ldeluigi/markdown-docs github-packages:ghcr.io/ldeluigi/markdown-docs dockerhub:deloo/markdown-docs

Additional context:
This action can be used in a minimal workflow even in this project, thus solving issue #174 with zero/minimal configuration:

See the usage example: https://github.com/marketplace/actions/markdown-docs#usage

Example:

name: GitHub Documentation

on:
  push:
    branches:
      - main

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

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  github-pages:
    name: Build and deploy documentation
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4
        with:
          fetch-depth: 0 # To enable the git based extensions that lookup history
      - name: Build documentation 📚
        uses: ldeluigi/markdown-docs@v0
        with:
          src: .
          dst: ./gh-pages
          title: MkDocs Catalog
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./gh-pages
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

[pawamoy]

Hey, thanks for the suggestion! And sorry for the delay: just like you, I'm not sure in which category this should land 🤔 I suppose we could indeed add a "build wrappers / modifiers" category or something. A few of the items in "other" would fit there too.

[pawamoy]

I dispatched the projects in the "Other" category to the rest of the categories in #188. I believe your project would fit in the "Site management" category, as other builders/wrappers are listed there. We can consider renaming the category to "Site building / management" to better represent that.

[ldeluigi]

I dispatched the projects in the "Other" category to the rest of the categories in #188. I believe your project would fit in the "Site management" category, as other builders/wrappers are listed there. We can consider renaming the category to "Site building / management" to better represent that.

Would you like to also receive a PR with a workflow that builds and publishes github pages?

Edit: I mean adding a job after the gh release

[pawamoy]

Would you like to also receive a PR with a workflow that builds and publishes github pages?

Not yet, I'd like #165 to be merged first. Then we can discuss it in more details in #174.

[pawamoy]

Hey @ldeluigi, I just merged #188 so you can open a PR to add your markdown-docs project if you want 🙂 You can add it to the "Site building, site management" category (slug=site-management).