From 2587cf0c2b41aa73284b14536fd1377072d87ab5 Mon Sep 17 00:00:00 2001 From: lulunac27a <100660343+lulunac27a@users.noreply.github.com> Date: Fri, 8 Mar 2024 20:30:31 -0600 Subject: [PATCH] Add docs in GitHub Pages --- .github/workflows/docs.yml | 28 ++++++++++++++++++++++++++++ docs/index.md | 2 ++ mkdocs.yml | 3 +++ 3 files changed, 33 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..f58f8c4 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,28 @@ +name: docs +on: + push: + branches: + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9449340 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,2 @@ +# Text Counter Applications in Java, Kotlin and Groovy +This repository contains text counter applications for Java, Kotlin, and Groovy languages. All files in this repository have Java Swing and JavaFX versions of the text counter applications and it can calculate the character, word, and line counts for the entered text box area and the uploaded text files. JavaFX files are available in both JavaFX code and FXML files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..99f0b7e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: Text Counter Application in Java, Kotlin, Scala and Groovy +theme: material +repo_url: https://github.com/lulunac27a/text-counter-java-application \ No newline at end of file