diff --git a/.github/workflows/manpages.yml b/.github/workflows/manpages.yml new file mode 100644 index 0000000000..0132cfa687 --- /dev/null +++ b/.github/workflows/manpages.yml @@ -0,0 +1,53 @@ +name: Generate man pages + +on: + push: + paths: + - "Base/usr/share/man/**" + +env: + MAN_DIR: ${{ github.workspace }}/Base/usr/share/man/ + +jobs: + convert_using_pandoc: + runs-on: ubuntu-20.04 + if: always() && github.repository == 'SerenityOS/serenity' && github.ref == 'refs/heads/master' + steps: + - uses: actions/checkout@v2 + - uses: r-lib/actions/setup-pandoc@v1 + with: + pandoc-version: '2.13' + - name: Prepare output directories + run: | + for d in $MAN_DIR*/; do + mkdir -p output/$(basename "$d") + done + - name: Convert markdown to html + run: | + find $MAN_DIR -iname '*.md' -type f -exec sh -c 'relative=$(realpath --relative-to=$MAN_DIR $0) && pandoc -f gfm -t html5 -s -o output/${relative%.md}.html ${0}' {} \; + - name: Generate man page listings + run: | + for d in output/*/; do + dir_name=$(basename "$d") + echo "$dir_name" > "$d/index.html" + for f in $d/*; do + file_name=$(basename "$f") + if [[ "$file_name" == "index.html" ]]; then + continue + fi + echo "

${file_name%.html}

" >> "$d/index.html" + done + echo "" >> "$d/index.html" + done + - name: Copy pre-made files + run: | + cp -R Meta/Websites/man.serenityos.org/* output/ + - name: Deploy to github pages + uses: JamesIves/github-pages-deploy-action@4.1.1 + with: + git-config-name: BuggieBot + git-config-email: buggiebot@serenityos.org + branch: master + repository-name: SerenityOS/manpages-website + token: ${{ secrets.BUGGIEBOT }} + folder: output diff --git a/Meta/Websites/man.serenityos.org/banner.png b/Meta/Websites/man.serenityos.org/banner.png new file mode 100644 index 0000000000..872cf0eee5 Binary files /dev/null and b/Meta/Websites/man.serenityos.org/banner.png differ diff --git a/Meta/Websites/man.serenityos.org/index.html b/Meta/Websites/man.serenityos.org/index.html new file mode 100644 index 0000000000..a6b2683f91 --- /dev/null +++ b/Meta/Websites/man.serenityos.org/index.html @@ -0,0 +1,18 @@ + + + + SerenityOS man pages + + +SerenityOS +

SerenityOS man pages

+

Man 1

+

Man 2

+

Man 3

+

Man 4

+

Man 5

+

Man 6

+

Man 7

+

Man 8

+ +