Skip to content

Commit

Permalink
chore: add techdocs support (#18)
Browse files Browse the repository at this point in the history
* chore: add techdocs support

* Update index.md

Signed-off-by: Pasi Romo <[email protected]>

---------

Signed-off-by: Pasi Romo <[email protected]>
Co-authored-by: backstage-idealo[bot] <127739812+backstage-idealo[bot]@users.noreply.github.com>
Co-authored-by: Pasi Romo <[email protected]>
  • Loading branch information
backstage-idealo[bot] and pasi-romo-idealo authored May 16, 2024
1 parent f4894d4 commit d239425
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/techdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Build and publish docs
uses: idealo/publish-techdocs-action@v3
with:
component-name: 'github-app-token-generator'
11 changes: 2 additions & 9 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
site_name: 'your documentation site name'
site_description: 'a brief description'
#uncomment the below lines if you want to enable the edit button in your techdocs
edit_uri: blob/main/docs/ #don't change it, just uncomment
repo_url: 'https://github.com/idealo/github-app-token-generator'
theme:
name: material
palette:
scheme: default
features:
- toc.follow
- toc.integrate
#edit_uri: blob/main/docs/ #don't change it, just uncomment
#repo_url: '<insert your repo url here>'
plugins:
- techdocs-core

0 comments on commit d239425

Please sign in to comment.