Skip to content

Commit

Permalink
feat: implement bookstack page client
Browse files Browse the repository at this point in the history
  • Loading branch information
pascal-zarrad committed Sep 22, 2023
1 parent c896b40 commit 6ec313b
Show file tree
Hide file tree
Showing 10 changed files with 1,007 additions and 16,778 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ making it available in your central documentation solution.
This action features:
- Sync to either a chapter or a book
- Use either a single file or a glob pattern to sync multiple files
- Add tags to the generated pages
- Keep your pages up to date - the action can create and update pages

## Limitations
Expand Down Expand Up @@ -45,9 +44,6 @@ Also this sync is currently one way, so deleting files from the repo won't delet
- **Required, when `book-id` is not set**
- The ID of the book to sync to.

### `tags`
- The tags to add to the page, comma separated

### `path`
- The path to the markdown file(s) to sync, you can use glob patterns for multiple files

Expand All @@ -65,7 +61,6 @@ with:
# You only need one of book-id or chapter-id
book-id: 123
chapter-id: 123
tags: 'action,sync,bookstack'
# You can either use a path to a file or a glob pattern:
path: 'sub/directories/README.md'
path: 'sub/*/*.md'
Expand Down
3 changes: 0 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ inputs:
chapter-id:
description: 'The ID of the chapter to sync to'
required: false
tags:
description: 'The tags to add to the page, comma separated'
required: false
path:
description: 'The path to the markdown file(s) to sync, you can use glob patterns for multiple files'
required: true
Expand Down
Loading

0 comments on commit 6ec313b

Please sign in to comment.