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

docs: multiple content updates #57

Merged
merged 1 commit into from
Nov 21, 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 astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export default defineConfig({
},
},
{
label: "Classes and styles",
label: "Classes, styles, HTML",
autogenerate: {
directory: "classes",
},
Expand Down
Binary file added public/img/thismoi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions src/content/docs/classes/details.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: details
---

The `<details>` disclosure element is an HTML element that creates a disclosure widget in which information is visible only when the widget is toggled into an open state. A `summary` or label must be provided using the `<summary>` element. - [MDN web docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details)

:::note
We also have an in-house [Disclosure component](/shared/disclosure), but we decided in October 2024 to move away from using it. We may deprecate the component completely in the future.
:::

You can nest any other Markdown syntax inside a `<details>` element. Some, if not all, of Starlight's components can also be nested. For example, you can use an aside within the element.

## Example usage

```html
<details>
<summary>Who has two thumbs, speaks limited French, and hasn't cried once today?</summary>
<img
src="/img/thismoi.png"
alt="Liz Lemon"
style="max-width:200px"
/>
</details>
```

<details>
<summary>Who has two thumbs, speaks limited French, and hasn't cried once today?</summary>
<img
src="/img/thismoi.png"
alt="Liz Lemon"
style="max-width:200px"
/>
</details>
12 changes: 7 additions & 5 deletions src/content/docs/content/global.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Use sentence case for headings, subheadings, and page titles unless a word/term

### Initialisms

Capitalize each letter in an initialism. For example, WM for Web Monetization.
Capitalize each letter in an initialism. For example, ASE for account servicing entity.

### Commas

Expand All @@ -77,11 +77,11 @@ Typically, partials should be used for small chunks of repeating content. If the

Note:

- Don’t include front matter in your partials file.
- Don’t include frontmatter in your partials file (e.g., `title`).
- Headings within a partials file do not appear in a page’s table of contents.
- Multiple partial files are supported within a single page.

### Embed a partial file
### Embed a partial

First, import the partial file into the page:

Expand All @@ -99,13 +99,15 @@ This is a paragraph of text. I want the partial content to appear beneath this p
<NoPay />
```

That's it!

## Digital wallet vs account

The term _digital wallet_ can be interpreted a number of ways and we want to be as unambiguous as possible. Be aware of the context in which you’re using the term. Think about whether _account_ or _Open Payments-enabled account_ would be more accurate than _digital wallet_.

## Doc file extensions (MD/MDX)

Create new doc files in MDX unless there’s a need for something else.
Create new doc files in MDX unless you have a good reason not to.

## Example URLs, including wallet addresses

Expand All @@ -126,7 +128,7 @@ Reference: https://en.wikipedia.org/wiki/Example.com

### Overviews

Starlight automatically sets the first heading on a page to Overview, even if the markdown file has an H1 or H2 defined.
Starlight automatically sets the first heading on a page to "Overview", even if the markdown file has an H1 or H2 defined.

## Images

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/content/interledger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Interledger (developers) style guide

import { Card } from '@astrojs/starlight/components';

<Card title="After a Starlight upgrade" icon="star">
<Card title="After a Starlight upgrade to interledger.org-developers" icon="star">
```
cd <to project folder>
bun install
Expand Down
Loading
Loading