Skip to content
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.

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

Proofread some grammar and typos in the docs #1692

Merged
merged 6 commits into from
Dec 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/notebooks-with-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The `kernelspec` configuration should be defined in the _page-level_ frontmatter
- human-readable name for the kernel, e.g. "Python 3.12"
```

The following contents is a frontmatter defines a document that uses the `python` kernel:
The following content is a frontmatter that defines a document that uses the `python` kernel:

```yaml
kernelspec:
Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart-myst-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Next we will improve the contents of the `01-paper.md`, including:
The start of the file includes information about the title, subtitle, author, affiliations and license.
Unfortunately, this way of including this information is not easily machine-readable[^fair], and focuses more on style/typography than on metadata.

[^fair]: [FAIR principles](https://www.go-fair.org/fair-principles/) are at the heart of open-science, and aim to **F**indability, **A**ccessibility, **I**nteroperability, and **R**euse of digital assets. For a resource to be finable, it must be machine-readable!
[^fair]: [FAIR principles](https://www.go-fair.org/fair-principles/) are at the heart of open-science, and aims for the **F**indability, **A**ccessibility, **I**nteroperability, and **R**euse of digital assets. For a resource to be findable, it must be machine-readable!

```markdown
# How to MyST, without being mystified 🧙
Expand Down Expand Up @@ -116,14 +116,14 @@ keywords: myst, markdown, open-science
```

In this case, we are also adding additional metadata like an ORCID, as well as ensuring the license is an SPDX compatible code.
Once these are added, the myst theme (in this case the `book-theme` template) can make it look pretty, this can also be customized by other themes, including $\LaTeX$ and Microsoft Word templates!
Once these are added, the MyST theme (in this case the `book-theme` template) can make it look pretty, this can also be customized by other themes, including $\LaTeX$ and Microsoft Word templates!

:::{figure} ./images/frontmatter-after.png
:width: 80%
:label: frontmatter-after
:class: framed

The myst theme for the `01-paper.md` page after the frontmatter changes are added. Compare this to what it looked like before in [](#frontmatter-before-pdf). The structure of the HTML page has also been improved, including meta tags that are available to search engines and other programmatic indexers.
The MyST theme for the `01-paper.md` page after the frontmatter changes are added. Compare this to what it looked like before in [](#frontmatter-before-pdf). The structure of the HTML page has also been improved, including meta tags that are available to search engines and other programmatic indexers.
:::

### Add an abstract part
Expand Down
Loading