Skip to content

docs: give the Quickstart and Changelog nav entries real pages #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roshaninfordham wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: give the Quickstart and Changelog nav entries real pages #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ rf = roboflow.Roboflow(api_key="")

</details>

<!-- --8<-- [start:quickstart] -->
## Quickstart

Below are some common methods used with the Roboflow Python package, presented concisely for reference. For a full library reference, refer to the [Roboflow API reference documentation](https://docs.roboflow.com/api-reference).
Expand Down Expand Up @@ -155,6 +156,8 @@ predictions = model.predict(img_url, hosted=True).json()
print(predictions)
```

<!-- --8<-- [end:quickstart] -->

### Search and Export

Search for images across your workspace and export matching results as a ready-to-use dataset:
Expand Down
1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CHANGELOG.md"
1 change: 1 addition & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "README.md:quickstart"
3 changes: 3 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.snippets:
base_path: ['.']
check_paths: true
- attr_list
- md_in_html
- pymdownx.tabbed:
Expand Down