Skip to content

Commit

Permalink
feat: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shinokada committed Dec 15, 2022
1 parent 5923211 commit 4a32db4
Show file tree
Hide file tree
Showing 31 changed files with 1,759 additions and 3,008 deletions.
13 changes: 13 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.DS_Store
node_modules
/build
/.svelte-kit
/package
.env
.env.*
!.env.example

# Ignore files for PNPM, NPM and YARN
pnpm-lock.yaml
package-lock.json
yarn.lock
20 changes: 20 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = {
root: true,
parser: '@typescript-eslint/parser',
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
plugins: ['svelte3', '@typescript-eslint'],
ignorePatterns: ['*.cjs'],
overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
settings: {
'svelte3/typescript': () => require('typescript')
},
parserOptions: {
sourceType: 'module',
ecmaVersion: 2020
},
env: {
browser: true,
es2017: true,
node: true
}
};
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ node_modules
.env
.env.*
!.env.example
.npmrc
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
9 changes: 0 additions & 9 deletions .npmignore

This file was deleted.

13 changes: 13 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.DS_Store
node_modules
/build
/.svelte-kit
/package
.env
.env.*
!.env.example

# Ignore files for PNPM, NPM and YARN
pnpm-lock.yaml
package-lock.json
yarn.lock
20 changes: 17 additions & 3 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
{
"useTabs": true,
"useTabs": false,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100
}
"printWidth": 100,
"plugins": [
"prettier-plugin-svelte"
],
"pluginSearchDirs": [
"."
],
"overrides": [
{
"files": "*.svelte",
"options": {
"parser": "svelte"
}
}
]
}
Empty file added docs/.nojekyll
Empty file.
29 changes: 20 additions & 9 deletions README.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Svelte-heros
<h1 align="center">Svelte-heros</h1>

<p align="center">
<a href="https://shinokada.github.io/svelte-heros/">Svelte-heros</a>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/svelte-heros" rel="nofollow"><img src="https://img.shields.io/npm/v/svelte-heros" alt="npm"></a>
<a href="https://twitter.com/shinokada" rel="nofollow"><img src="https://img.shields.io/badge/created%20by-@shinokada-4BBAAB.svg" alt="Created by Shin Okada"></a>
<a href="https://www.apache.org/licenses/" rel="nofollow"><img src="https://img.shields.io/github/license/shinokada/svelte-heros" alt="License"></a>
<a href="https://www.npmjs.com/package/svelte-heros" rel="nofollow"><img src="https://img.shields.io/npm/dw/svelte-heros.svg" alt="npm"></a>
</p>

New version, [Svelte-Heros-v2](https://github.com/shinokada/svelte-heros-v2) is out.

Expand All @@ -9,20 +20,16 @@ Hero Icons v1 for Svelte. You can select outline and solid icons using the varia
<img width="450" src="https://raw.githubusercontent.com/shinokada/svelte-heros/main/static/images/heros2.webp" />
</p>

## Original source

[tailwindlabs/heroicons](https://github.com/tailwindlabs/heroicons)

## List of icons

[Icon names](https://github.com/shinokada/svelte-heros/blob/main/icon-list.md)

## Installation

```sh
npm i svelte-heros@latest
```

## List of icons

[Icon names](https://github.com/shinokada/svelte-heros/blob/main/docs/icon-list.md)

## REPL

- [Demo 1](https://svelte.dev/repl/6b774b2f8ecb402a865fac0a141e3c4a?version=3.48.0)
Expand Down Expand Up @@ -151,6 +158,10 @@ Use `import * as Icon from 'svelte-heros`.
<Map size="50" on:click={() => (isSolid = !isSolid)} variation={isSolid ? 'solid' : 'outline'} />
```

## Original source

[tailwindlabs/heroicons](https://github.com/tailwindlabs/heroicons)

## Other icons

- [Svelte-Icon-Sets](https://svelte-svg-icons.vercel.app/)
File renamed without changes.
79 changes: 79 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8" />
<title>Svelte Heros</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Hero Icons v1 for Svelte." />
<meta name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" />
<style>
.markdown-section {
max-width: 700px;
}
</style>
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:creator" content="@shinokada" />
<meta name="twitter:title" content="Svelte Heros" />
<meta name="twitter:description" content="Hero Icons v1 for Svelte." />
<meta name="twitter:image" content="https://open-graph-vercel.vercel.app/api/svelte-heros" />
<meta name="twitter:image:alt" content="Svelte Heros" />
<meta property="fb:app_id" content="1107438173296844" />
<meta property="og:url" content="https://shinokada.github.io/svelte-heros/" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Svelte Heros" />
<meta property="og:description" content="Hero Icons v1 for Svelte." />
<meta property="og:image" content="https://open-graph-vercel.vercel.app/api/svelte-heros" />
<meta property="og:image:alt" content="Svelte Heros" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<!-- Google Tag Manager -->
<script>(function (w, d, s, l, i) {
w[l] = w[l] || []; w[l].push({
'gtm.start':
new Date().getTime(), event: 'gtm.js'
}); var f = d.getElementsByTagName(s)[0],
j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-MMH952R');</script>
<!-- End Google Tag Manager -->
</head>

<body>
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MMH952R" height="0" width="0"
style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<nav style="
display: flex;
flex-direction: row;
align-items: center;
justify-content: space-between;
">
<!-- <ul><li href="/link">Link 1</li></ul> -->
</nav>
<div id="app"></div>
<script>
window.$docsify = {
subMaxLevel: 1,
maxLevel: 3,
auto2top: true,
repo: 'shinokada/svelte-heros',
routerMode: 'history',
crossOriginLinks: [
'https://twitter.com/shinokada',
'https://www.npmjs.com/package/svelte-heros',
'https://twitter.com/shinokada',
'http://www.apache.org/licenses/',
'https://opensource.org/licenses/MIT',
'https://www.npmjs.com/package/svelte-heros',
'https://shinokada.github.io/svelte-heros/'
]
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>

</html>
3 changes: 0 additions & 3 deletions jsconfig.json

This file was deleted.

52 changes: 28 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,35 @@
"homepage": "https://github.com/shinokada/svelte-heros",
"license": "MIT",
"scripts": {
"dev": "svelte-kit dev",
"build": "svelte-kit build",
"package": "svelte-kit package",
"preview": "svelte-kit preview",
"test": "vitest",
"format": "prettier --ignore-path .gitignore --write --plugin-search-dir=. .",
"prepare": "husky install"
"dev": "vite dev",
"build": "svelte-kit sync && svelte-package",
"prepublishOnly": "echo 'Did you mean to publish `./package/`, instead of `./`?' && exit 1",
"test": "playwright test",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"test:unit": "vitest",
"lint": "prettier --plugin-search-dir . --check . && eslint .",
"format": "prettier --plugin-search-dir . --write .",
"package:publish": "standard-version && git push --follow-tags origin main && npm run build && npm publish ./package"
},
"devDependencies": {
"@sveltejs/adapter-auto": "next",
"@sveltejs/kit": "next",
"@testing-library/jest-dom": "^5.16.4",
"@testing-library/svelte": "^3.1.3",
"autoprefixer": "^10.4.2",
"postcss": "^8.4.5",
"postcss-load-config": "^3.1.1",
"prettier": "2.7.1",
"prettier-plugin-svelte": "^2.7.0",
"svelte": "^3.44.0",
"svelte-preprocess": "^4.10.1",
"svelte2tsx": "^0.5.3",
"tailwindcss": "^3.0.12",
"typescript": "^4.7.3",
"vitest": "^0.14.1",
"husky": "^8.0.0"
"@playwright/test": "^1.28.1",
"@sveltejs/adapter-auto": "^1.0.0",
"@sveltejs/kit": "^1.0.0",
"@sveltejs/package": "^1.0.0",
"@typescript-eslint/eslint-plugin": "^5.45.0",
"@typescript-eslint/parser": "^5.45.0",
"eslint": "^8.28.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-svelte3": "^4.0.0",
"prettier": "^2.8.0",
"prettier-plugin-svelte": "^2.8.1",
"svelte": "^3.54.0",
"svelte-check": "^2.9.2",
"tslib": "^2.4.1",
"typescript": "^4.9.3",
"vite": "^4.0.0",
"vitest": "^0.25.3"
},
"type": "module",
"main": "index.js",
Expand All @@ -50,4 +54,4 @@
"type": "git",
"url": "https://github.com/shinokada/svelte-heros"
}
}
}
11 changes: 11 additions & 0 deletions playwright.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import type { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
webServer: {
command: 'npm run build && npm run preview',
port: 4173
},
testDir: 'tests'
};

export default config;
Loading

0 comments on commit 4a32db4

Please sign in to comment.