Skip to content

Commit

Permalink
Attach PDF to the online documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fiffeek committed Jun 2, 2024
1 parent 163a9f3 commit 9d0a821
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 17 deletions.
21 changes: 4 additions & 17 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
# Beeflow

<object data="sairflow.pdf" type="application/pdf" style="width: 100%; height: 1200px">
<embed src="sairflow.pdf" type="application/pdf" />
</object>
5 changes: 5 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,8 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.pathconverter:
base_path: "beeflow"
relative_path: ""
absolute: false
tags: "a script img link object embed"
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
mkdocs==1.3.0
mkdocs-material==8.3.5
mkdocs-material-extensions==1.3.1
pymdown-extensions==10.8.1

0 comments on commit 9d0a821

Please sign in to comment.