Skip to content

Commit

Permalink
Merge pull request #71 from 8845musign/update-documents
Browse files Browse the repository at this point in the history
Update documents
  • Loading branch information
takanorip authored May 27, 2024
2 parents e6ec87e + 06ffb21 commit e7075fb
Show file tree
Hide file tree
Showing 52 changed files with 577 additions and 53 deletions.
3 changes: 3 additions & 0 deletions .scaffdog/pageComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import ExampleLayout from '@layouts/ExampleLayout.astro';
<ExampleLayout title="Default Example | {{ inputs.componentName | pascal }}">
<DefaultExample client:only="react" />
</ExampleLayout>
```

# `pages/components/{{ inputs.componentName }}.mdx`
Expand All @@ -43,6 +44,7 @@ exampleKey: '{{ inputs.componentName }}'
layout: '@layouts/ComponentLayout.astro'
description: ''
thumbnail: '/assets/images/components/thumbnail-default.svg'
repositoryUrl: ''
---

## Feature
Expand All @@ -52,4 +54,5 @@ Describe the characteristics of the component. Describe the use cases to which i
## Usage

Please describe the specific use of the product. Detailed notes on use, code example, etc.

```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ Implement the most basic example.
### Add Component Example

```
npm run generate:example
npm run generate:page:example
```
206 changes: 172 additions & 34 deletions package-lock.json

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

12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@
"script:extract-icon-names": "node ./scripts/extractIconNames.js",
"test": "vitest",
"generate:page:component": "scaffdog generate pageComponent",
"generate:example": "scaffdog generate example"
"generate:page:example": "scaffdog generate example"
},
"dependencies": {
"@astrojs/check": "^0.6.0",
"@astrojs/mdx": "^2.3.1",
"@astrojs/check": "^0.7.0",
"@astrojs/mdx": "^3.0.1",
"@astrojs/prism": "^3.1.0",
"@astrojs/react": "^3.3.2",
"@astrojs/react": "^3.4.0",
"@astrojs/renderer-react": "^0.5.0",
"@nanostores/react": "^0.7.2",
"@types/react": "^18.2.79",
"@types/react-dom": "^18.2.25",
"@types/react-syntax-highlighter": "^15.5.11",
"@ubie/design-tokens": "^0.1.4",
"@ubie/ubie-icons": "^0.6.2",
"@ubie/ubie-ui": "^0.0.21",
"@ubie/ubie-ui": "^0.0.22",
"@unocss/reset": "^0.59.4",
"astro": "^4.7.1",
"astro": "^4.9.1",
"astro-icon": "^1.1.0",
"clsx": "^2.1.1",
"color-blend": "^4.0.0",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions src/components/astro/RepositoryLink.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
import GitHubMark from '@assets/images/github-mark.svg';
import { Image } from 'astro:assets';
interface Props {
href: string;
targetName: string;
}
const { href, targetName } = Astro.props;
---

<a href={href} class="repositoryLink">
<Image alt="" src={GitHubMark} aria-hidden="true" width={17} />
View on GitHub<span class="visuallyHidden">: {targetName}</span>
</a>

<style>
.repositoryLink {
display: inline-flex;
gap: var(--size-spacing-xs);
align-items: center;
font-weight: bold;
color: var(--color-text-main);
}
</style>
Loading

0 comments on commit e7075fb

Please sign in to comment.