Skip to content

Commit

Permalink
Merge pull request #260 from kinode-dao/hf/output-a-single-md-file
Browse files Browse the repository at this point in the history
output a single .md file: the entire book contents
  • Loading branch information
nick1udwig authored Nov 15, 2024
2 parents 9d5ac5f + 767de9e commit 2f70f9a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
13 changes: 11 additions & 2 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ jobs:
- uses: actions/checkout@v4
- name: Install mdBook
run: |
cargo install --git https://github.com/nick1udwig/mdBook --branch hf/dont-write-searchindex-json --locked mdbook
cargo install --git https://github.com/nick1udwig/mdBook --branch hf/output-single-md-file --locked mdbook
cargo install mdbook-linkcheck
cargo install mdbook-webinclude
cargo install --git https://github.com/nick1udwig/mdbook-hide-feature --locked
Expand All @@ -166,7 +166,7 @@ jobs:
release_name: Release ${{ github.run_number }}
draft: false
prerelease: false
- name: Upload Release Asset
- name: Upload Release Asset (.tar.gz)
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -175,6 +175,15 @@ jobs:
asset_path: ./book.tar.gz
asset_name: book.tar.gz
asset_content_type: application/gzip
- name: Upload Release Asset (.md)
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: ./book/single-file/book.md
asset_name: book.md
asset_content_type: text/markdown

deploy:
environment:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Get deps:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
cargo install --git https://github.com/nick1udwig/mdBook --branch hf/dont-write-searchindex-json --locked mdbook
cargo install --git https://github.com/nick1udwig/mdBook --branch hf/output-single-md-file --locked mdbook
cargo install mdbook-linkcheck
cargo install mdbook-webinclude
cargo install --git https://github.com/nick1udwig/mdbook-hide-feature --locked
Expand Down
2 changes: 2 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ level = 1

[output.linkcheck]

[output.single_file]

[preprocessor.webinclude]

[preprocessor.hide-feature]

0 comments on commit 2f70f9a

Please sign in to comment.