Skip to content

Commit

Permalink
Add docs in GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
lulunac27a committed Mar 9, 2024
1 parent c176e28 commit 2587cf0
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2587cf0

Please sign in to comment.