Skip to content

Commit

Permalink
feat(docs): introduce vue press documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tchiotludo committed Oct 24, 2021
1 parent cdf5fdf commit 430b80a
Show file tree
Hide file tree
Showing 74 changed files with 19,792 additions and 2,447 deletions.
32 changes: 21 additions & 11 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Main
on:
push:
branches:
- master
- dev

jobs:
check:
Expand All @@ -13,10 +13,26 @@ jobs:
steps:
- uses: actions/checkout@v2

# Web site
# Setup
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '14'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

# Build
- name: Build
working-directory: docs
run: |
npm install
node_modules/.bin/githubcontrib --repo akhq --owner tchiotludo --format html --sortOrder desc > .vuepress/public/contributors.html
npm run build
echo "akhq.io" > .vuepress/dist/CNAME
# Copy for helm
- name: Add some files
run: |
echo "akhq.io" > docs/CNAME
cp LICENSE helm/akhq/LICENSE
cp README.md helm/akhq/README.md
Expand All @@ -38,21 +54,15 @@ jobs:
- name: Add helm charts
run: |
rm -rf tmp-helm/.git
cp -R tmp-helm/* docs/
# Contributors
- name: Contributor
run: |
npm i github-contributors-list
node_modules/.bin/githubcontrib --repo akhq --owner tchiotludo --format html --sortOrder desc > docs/contributors.html
cp -R tmp-helm/* docs/.vuepress/dist/
# Deploy
- name: Deploy
uses: peaceiris/actions-gh-pages@v2
env:
PERSONAL_TOKEN: ${{ secrets.GITHUB_PERSONAL_TOKEN }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: docs/
PUBLISH_DIR: docs/.vuepress/dist/

# Slack
- name: Slack notification
Expand Down
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,11 @@ docker-compose.override.yml
## Helm
helm/akhq/README.md
helm/akhq/LICENSE


## Docs
docs/node_modules
docs/.vuepress/.temp
docs/.vuepress/.cache
docs/.vuepress/public/contributors.html
docs/.vuepress/dist
Loading

0 comments on commit 430b80a

Please sign in to comment.