-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
23 changed files
with
4,992 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
# Created by https://www.toptal.com/developers/gitignore/api/node,npm,vuejs,typescript | ||
# Edit at https://www.toptal.com/developers/gitignore?templates=node,npm,vuejs,typescript | ||
|
||
### Node ### | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
### Node Patch ### | ||
# Serverless Webpack directories | ||
.webpack/ | ||
|
||
# Optional stylelint cache | ||
|
||
# SvelteKit build / generate output | ||
.svelte-kit | ||
|
||
#!! ERROR: npm is undefined. Use list command to see defined gitignore types !!# | ||
|
||
#!! ERROR: typescript is undefined. Use list command to see defined gitignore types !!# | ||
|
||
### Vuejs ### | ||
# Recommended template: Node.gitignore | ||
|
||
dist/ | ||
npm-debug.log | ||
yarn-error.log | ||
|
||
# End of https://www.toptal.com/developers/gitignore/api/node,npm,vuejs,typescript | ||
|
||
/coverage | ||
/src/client/shared.ts | ||
/src/node/shared.ts | ||
*.log | ||
*.tgz | ||
.DS_Store | ||
.idea | ||
.temp | ||
.vite_opt_cache | ||
.vscode | ||
dist | ||
cache | ||
temp | ||
examples-temp | ||
node_modules | ||
pnpm-global | ||
TODOs.md | ||
*.timestamp-*.mjs | ||
|
||
public/swift-docc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
lts/jod |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
import { defineConfig } from 'vitepress' | ||
import * as fs from 'fs'; | ||
import doccData from '../docc.data'; | ||
|
||
const modules = doccData.load() | ||
|
||
// https://vitepress.dev/reference/site-config | ||
export default defineConfig({ | ||
title: "Bushel API", | ||
description: "Developer Docs", | ||
vite : { | ||
assetsInclude : ["**/*.json"] | ||
}, | ||
themeConfig: { | ||
// https://vitepress.dev/reference/default-theme-config | ||
nav: [ | ||
{ text: 'Home', link: '/' }, | ||
{ text: 'REST API', link: '/rest' }, | ||
{ text: 'CLI', link: '/cli' }, | ||
{ text: 'Swift DocC', link: '/docc'}, | ||
{ text: 'Get Bushel', link: 'https://getbushel.app'} | ||
], | ||
sidebar: [ | ||
{ | ||
text: "REST API", | ||
items: [ | ||
{ text: 'Introduction', link: '/rest/' }, | ||
{ text: 'Getting Started', link: '/rest/getting-started' }, | ||
{ | ||
text: 'Endpoints', | ||
items: [ | ||
{ text: 'Library', link: '/rest/endpoints/libraries' }, | ||
{ text: 'Machine', link: '/rest/endpoints/machines' }, | ||
{ text: 'Images', link: '/rest/endpoints/images' }, | ||
{ text: 'Screenshots', link: '/rest/endpoints/screenshots' }, | ||
{ text: 'Snapshots', link: '/rest/endpoints/snapshots' } | ||
] | ||
} | ||
] | ||
}, | ||
{ | ||
text: "CLI", | ||
items: [ | ||
{ text: 'Introduction', link: '/cli/' }, | ||
{ text: 'Getting Started', link: '/cli/getting-started' }, | ||
{ | ||
text: 'Subcommands', | ||
items: [ | ||
{ text: 'Library', link: '/cli/subcommands/libraries' }, | ||
{ text: 'Machine', link: '/cli/subcommands/machines' }, | ||
{ text: 'Images', link: '/cli/subcommands/images' }, | ||
{ text: 'Screenshots', link: '/cli/subcommands/screenshots' }, | ||
{ text: 'Snapshots', link: '/cli/subcommands/snapshots' } | ||
] | ||
} | ||
] | ||
}, | ||
{ | ||
text: "Swift DocC", | ||
items: [ | ||
{ text: 'Introduction', link: '/docc/' }, | ||
{ | ||
text: 'Modules', | ||
items: modules | ||
} | ||
] | ||
} | ||
], | ||
|
||
socialLinks: [ | ||
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' } | ||
] | ||
} | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# Markdown Extension Examples | ||
|
||
This page demonstrates some of the built-in markdown extensions provided by VitePress. | ||
|
||
## Syntax Highlighting | ||
|
||
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: | ||
|
||
**Input** | ||
|
||
````md | ||
```js{4} | ||
export default { | ||
data () { | ||
return { | ||
msg: 'Highlighted!' | ||
} | ||
} | ||
} | ||
``` | ||
```` | ||
|
||
**Output** | ||
|
||
```js{4} | ||
export default { | ||
data () { | ||
return { | ||
msg: 'Highlighted!' | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Custom Containers | ||
|
||
**Input** | ||
|
||
```md | ||
::: info | ||
This is an info box. | ||
::: | ||
|
||
::: tip | ||
This is a tip. | ||
::: | ||
|
||
::: warning | ||
This is a warning. | ||
::: | ||
|
||
::: danger | ||
This is a dangerous warning. | ||
::: | ||
|
||
::: details | ||
This is a details block. | ||
::: | ||
``` | ||
|
||
**Output** | ||
|
||
::: info | ||
This is an info box. | ||
::: | ||
|
||
::: tip | ||
This is a tip. | ||
::: | ||
|
||
::: warning | ||
This is a warning. | ||
::: | ||
|
||
::: danger | ||
This is a dangerous warning. | ||
::: | ||
|
||
::: details | ||
This is a details block. | ||
::: | ||
|
||
## More | ||
|
||
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). |
Oops, something went wrong.