Skip to content

Commit

Permalink
Fix Quickstart GIFs (#985)
Browse files Browse the repository at this point in the history
* fix file paths

* use standard markdown syntax instead of HTML

* Found mkdocs fix for centering images
  • Loading branch information
johnzl-777 authored Jun 11, 2024
1 parent bb8ab82 commit 17585b2
Showing 1 changed file with 8 additions and 25 deletions.
33 changes: 8 additions & 25 deletions docs/home/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,25 @@ As you develop your Bloqade program, you are expected to rely on pop-up "hints"

In [VS Code](https://code.visualstudio.com/) this is automatic, just type the `.` and see what options pop up:

<div align="center">
<picture>
<img src="/assets/quick_start/vscode-hints.gif" alt="VSCode Hints">
</picture>
</div>
![VSCode Hints](../assets/quick_start/vscode-hints.gif)

### JetBrains PyCharm

The same goes for [JetBrains PyCharm](https://www.jetbrains.com/pycharm/):

<div align="center">
<picture>
<img src="/assets/quick_start/pycharm-hints.gif" alt="PyCharm Hints">
</picture>
</div>
![PyCharm Hints](../assets/quick_start/pycharm-hints.gif)

### Jupyter Notebook

In a [Jupyter Notebook](https://jupyter.org/) you'll need to type `.` and then hit tab for the hints to appear:

<div align="center">
<picture>
<img src="/assets/quick_start/jupyter-hints.gif" alt="Jupyter Notebook Hints">
</picture>
</div>
![Jupyter Hints](../assets/quick_start/jupyter-hints.gif)

### IPython

The same goes for [IPython](https://ipython.readthedocs.io/en/stable/):

<div align="center">
<picture>
<img src="/assets/quick_start/ipython-hints.gif" alt="IPython Hints">
</picture>
</div>
![IPython Hints](../assets/quick_start/ipython-hints.gif)

## Defining Atom Geometry

Expand All @@ -62,11 +46,10 @@ You can easily visualize your geometries as well with `.show()`:
```python
more_complex_geometry.show()
```
<div align="center">
<picture>
<img src="/assets/quick_start/geometry-visualization.png" style="width: 50%" alt="Geometry Visualization">
</picture>
</div>
<figure markdown="span">
![IPython Hints](../assets/quick_start/geometry-visualization.png){ width="50%" }
</figure>


You can also add positions to a pre-defined geometry:

Expand Down

0 comments on commit 17585b2

Please sign in to comment.