Options
All
  • Public
  • Public/Protected
  • All
Menu

Package @tscmono/website

Gatsby

Gatsby minimal starter

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the minimal starter.

    # create a new Gatsby site using the minimal starter
npm init gatsby

  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd my-gatsby-site/
npm run develop

  3. Open the code and start customizing!

    Your site is now running at http://localhost:8000!

    Edit src/pages/index.js to see your site update in real-time!

  4. Learn more

Index

Type aliases

Variables

Functions

Object literals

Type aliases

BackgroundProps

BackgroundProps: OpacityProp & RendererOptions

OpacityProp

OpacityProp: { opacity?: undefined | number }

Type declaration

  • Optional opacity?: undefined | number

Point

Point: { impulse: number; x: number; y: number }

Type declaration

  • impulse: number
  • x: number
  • y: number

RendererOptions

RendererOptions: { color: string; edge: boolean; every: number; size: number; speed: number; tolerance: number; variance: number }

Type declaration

  • color: string
  • edge: boolean
  • every: number
  • size: number
  • speed: number
  • tolerance: number
  • variance: number

Variables

Const Canvas

Canvas: StyledComponent<{ as?: React.ElementType; theme?: Theme } & { opacity?: undefined | number }, ClassAttributes<HTMLCanvasElement> & CanvasHTMLAttributes<HTMLCanvasElement>, {}> = styled.canvas<OpacityProp>(`position: fixed;left: 0;top: 0;width: 100vw;height: 100vh;opacity: 0.3;z-index: -1;`,({ opacity = 0.3 }) => ({opacity,}),)

Const InternalLink

InternalLink: StyledComponent<GatsbyLinkProps<unknown> & { as?: React.ElementType; theme?: Theme }, {}, { ref?: React.Ref<InstanceType<C>> }> = styled(GatsbyLink)`color: #03a9f4;`

Const Link

Link: StyledComponent<{ as?: React.ElementType; theme?: Theme }, ClassAttributes<HTMLAnchorElement> & AnchorHTMLAttributes<HTMLAnchorElement>, {}> = styled.a`color: #03a9f4;`

Const Main

Main: StyledComponent<{ as?: React.ElementType; theme?: Theme }, ClassAttributes<HTMLElement> & HTMLAttributes<HTMLElement>, {}> = styled.main`display: flex;align-items: center;justify-content: center;flex-flow: column nowrap;width: 100vw;height: 100vh;`

Const Subtitle

Subtitle: StyledComponent<{ as?: React.ElementType; theme?: Theme }, ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement>, {}> = styled.h2`font-size: 1.5rem;background: radial-gradient(white, transparent);padding: 0 25px;`

Const Text

Text: StyledComponent<{ as?: React.ElementType; theme?: Theme } & ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement> & { children?: ReactNode } & { as?: React.ElementType; theme?: Theme }, {}, {}> = styled(Subtitle)`opacity: 0.8;font-weight: lighter;`

Const Title

Title: StyledComponent<{ as?: React.ElementType; theme?: Theme }, ClassAttributes<HTMLHeadingElement> & HTMLAttributes<HTMLHeadingElement>, {}> = styled.h1`font-size: 6rem;background: radial-gradient(white, transparent);padding: 6vmin;text-align: center;`

Const github

github: "http://github.com/sabinmarcu/tscmono" = "http://github.com/sabinmarcu/tscmono"

Const globalStyles

globalStyles: SerializedStyles = css`html, body, #___gatsby, #gatsby-focus-wrapper {width: 100vw;height: 100vh;font-family: sans-serif;margin: 0;padding: 0;font-size: max(1vmin, 10px);}* {box-sizing: border-box;}`

Const npm

npm: "http://npmjs.org/org/tscmono" = "http://npmjs.org/org/tscmono"

Functions

Const Background

  • Background(__namedParameters: { color: string; edge: boolean; every: number; opacity: undefined | number; size: number; speed: number; tolerance: number; variance: number }): Element

  • Parameters

    • __namedParameters: { color: string; edge: boolean; every: number; opacity: undefined | number; size: number; speed: number; tolerance: number; variance: number }
      • color: string
      • edge: boolean
      • every: number
      • opacity: undefined | number
      • size: number
      • speed: number
      • tolerance: number
      • variance: number

    Returns Element

Const IndexPage

  • IndexPage(): Element

  • Returns Element

Const NotFoundPage

  • NotFoundPage(): Element

  • Returns Element

Const Reset

  • Reset(): Element

  • Returns Element

Const makeRenderer

  • makeRenderer(ref: HTMLCanvasElement, __namedParameters: { color: string; edge: boolean; every: number; size: number; speed: number; tolerance: number; variance: number }): { canvas: HTMLCanvasElement; start: any; stop: any }

  • Parameters

    • ref: HTMLCanvasElement
    • __namedParameters: { color: string; edge: boolean; every: number; size: number; speed: number; tolerance: number; variance: number }
      • color: string
      • edge: boolean
      • every: number
      • size: number
      • speed: number
      • tolerance: number
      • variance: number

    Returns { canvas: HTMLCanvasElement; start: any; stop: any }

    • canvas: HTMLCanvasElement
    • start: function
      • start(): void

      • Returns void

    • stop: function
      • stop(): void

      • Returns void

Object literals

Const docs

docs: object

nightly

nightly: string = "http://staging.docs.tscmono.io/"

stable

stable: string = "http://docs.tscmono.io/"

Generated using TypeDoc