Skip to content

Commit

Permalink
updated image embed, pip install autobuild, comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sierra authored and Sierra committed Dec 7, 2024
1 parent 1125a3e commit ed7dbaa
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 20 deletions.
Binary file modified .DS_Store
Binary file not shown.
29 changes: 15 additions & 14 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added doc/Images/myst-markdown-comments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ We can use auto build to detect changes in code and trigger the build cycle on s

.. code-block:: python
python3 -m pip install sphinx-autobuild
sphinx-autobuild doc _build
Expand Down
57 changes: 51 additions & 6 deletions doc/learn_myst.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,65 @@ Code Block are created by indenting four spaces.
#### Comments
Comments use the '%' to precede the comment.

%
\% This is a comment on a single line.

This is also a single line comment

[//]: # (This is a comment.)
[//]: # (This is a
multiline comment.
It can span multiple lines.)

```{note}
:class: warning
Spaces must be included around ': # ('
```

We can achieve multiline comments also.

[//]: # (This is a
multiline comment.
It can span multiple lines.
Even if I just keep typing.
embedded in paranthesis.
)


[//]: # (This is a
multiline comment.
It can span multiple lines.
Even if I just keep typing.
As long as it is embedded in paranthesis.
)




% comment
[\\]: # (why all this for
a comment)

[Stack Overflow Markdown multiline discussion](https://stackoverflow.com/questions/4823468/comments-in-markdown)

\<!---
your comment \
goes here and \
here.
\--->

![screen shot of multiline comments html](images/myst-markdown-comments.png)

* Note there are three dashes.

---


#### Bullet Points

Can be dashes, '-', or '\*'.
Double asterisks leads to an empty circle bullet. \
'\* \*'
* * Double Bullet Example.

___

#### Embedded Images
Embedded images use:

Expand All @@ -71,6 +112,10 @@ Embedded images use:

![cartoon fish](./Images/fun-fish.webp "fun fish graphic")

To embed images from a local directory:

![screen shot of multiline comments html](images/myst-markdown-comments.png)

---

**HTML elements go in '_build' folder, not Markdown 'docs'.**
Expand Down

0 comments on commit ed7dbaa

Please sign in to comment.