3.2.5 • Published 6 years ago

@patternplate/api v3.2.5

Weekly downloads
247
License
MIT
Repository
github
Last release
6 years ago

Documentation and development interface for component libraries

@patternplate/api

  • Framework independent
  • Bring design docs to live with real components
  • Powerful search and meta data system

This is the contributor documentation for @patternplate/cli For user docs see patternplate.github.io

About @patternplate/api

@patternplate/api provides an express middleware for use with @patternplate/client, as well as a web socket emitting data about file changes and compilation processes.

Endpoints

  • / - Web socket
  • /state.json - Document and pattern tree
  • /demo/*.html - Demo renderings

WebSocket

The web socket on / emits the following events:

  • {type: "change", "payload": {file: "string", p: conntentType: "pattern" | "doc"}"}
  • {type: "error", "payload": Error"}
  • {type: "start", "payload": {target: "node" | "web"}}
  • {type: "done", "payload": {target: "node" | "web"}}

Quick start

git clone https://github.com/patternplate/patternplate.git
cd patternplate/packages/cli
yarn
yarn start

Usage

const http = require("http");
const api = require("@patternplate/api");

(async () => {
  const server = http.createServer();

  const apiRoute = await api({
    cwd: process.cwd(),
    server
  });

  const app = express().use("/api/", apiRoute)
})();

License

Copyright by SinnerSchrader. All @patternplate packages are released under the MIT license.

@marionebl/sander@patternplate/compiler@patternplate/load-config@patternplate/load-docs@patternplate/load-meta@patternplate/types@patternplate/validate-config@types/chokidar@types/dargs@types/express@types/glob-parent@types/memory-fs@types/micromatch@types/string-hash@types/ws@types/zen-observableaggregate-errorarsonchokidarcommon-dirdargsexpressglob-parentmemory-fsmicromatchrequire-from-stringresolve-pkgstring-hashts-transform-json-schemaunindentwsyargs-parserzen-observable
@infinitebrahmanuniverse/nolb-_pat@everything-registry/sub-chunk-707@patternplate/client
3.2.14

6 years ago

3.2.13

6 years ago

3.2.12

6 years ago

3.2.11

6 years ago

3.2.10

6 years ago

3.2.9

6 years ago

3.2.8

6 years ago

3.2.7

6 years ago

3.2.5

6 years ago

3.2.4

6 years ago

3.1.1

6 years ago

3.0.7-1

6 years ago

3.0.7-0

6 years ago

3.0.6

6 years ago

3.0.4

6 years ago

3.0.3

6 years ago

3.0.2

6 years ago

3.0.1

6 years ago

3.0.0

6 years ago

2.6.2-0

6 years ago

2.6.1-0

6 years ago

2.6.0-0

6 years ago

2.6.0-alpha.38464754

6 years ago

2.6.0-alpha.154b7b63

6 years ago

3.0.0-alpha.0

6 years ago

2.5.25

6 years ago

2.5.21

6 years ago

2.5.19

6 years ago

2.5.18

6 years ago

2.5.17

6 years ago

2.5.16

6 years ago

2.5.15

6 years ago

2.5.14

6 years ago

2.5.13

6 years ago

2.5.10

6 years ago

2.5.9

6 years ago

2.5.6

6 years ago

2.5.5

6 years ago

2.5.2

7 years ago

2.5.1

7 years ago

2.4.0

7 years ago

2.3.1

7 years ago

2.3.0

7 years ago

2.2.0

7 years ago

2.1.6

7 years ago

2.1.4

7 years ago

2.1.3

7 years ago

2.1.2

7 years ago

2.1.1

7 years ago

2.1.0

7 years ago

2.0.12

7 years ago

2.0.10

7 years ago

2.0.9

7 years ago

2.0.8

7 years ago

2.0.4

7 years ago

2.0.3

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago

2.0.0-93

7 years ago

2.0.0-92

7 years ago

2.0.0-91

7 years ago

2.0.0-90

7 years ago

2.0.0-89

7 years ago

2.0.0-88

7 years ago

2.0.0-87

7 years ago

2.0.0-86

7 years ago

2.0.0-85

7 years ago

2.0.0-84

7 years ago

2.0.0-83

7 years ago

2.0.0-82

7 years ago

2.0.0-81

7 years ago

2.0.0-80

7 years ago

2.0.0-79

7 years ago

2.0.0-78

7 years ago

2.0.0-77

7 years ago

2.0.0-76

7 years ago

2.0.0-75

7 years ago

2.0.0-74

7 years ago

2.0.0-73

7 years ago

2.0.0-72

7 years ago

2.0.0-71

7 years ago

2.0.0-70

7 years ago

2.0.0-69

7 years ago

2.0.0-68

7 years ago

2.0.0-67

7 years ago

2.0.0-66

7 years ago

2.0.0-65

7 years ago

2.0.0-63

7 years ago

2.0.0-62

7 years ago

2.0.0-61

7 years ago

2.0.0-60

7 years ago

2.0.0-59

7 years ago

2.0.0-58

7 years ago

2.0.0-57

7 years ago

2.0.0-56

7 years ago

2.0.0-55

7 years ago

2.0.0-54

7 years ago

2.0.0-53

7 years ago

2.0.0-52

7 years ago

2.0.0-51

7 years ago

2.0.0-50

7 years ago

2.0.0-49

7 years ago

2.0.0-48

7 years ago

2.0.0-47

7 years ago

2.0.0-46

7 years ago

2.0.0-45

7 years ago

2.0.0-44

7 years ago

2.0.0-43

7 years ago

2.0.0-42

7 years ago

2.0.0-41

7 years ago

2.0.0-40

7 years ago

2.0.0-39

7 years ago

2.0.0-38

7 years ago

2.0.0-y.0

7 years ago

2.0.0-37

7 years ago

2.0.0-36

7 years ago

2.0.0-35

7 years ago

2.0.0-34

7 years ago

2.0.0-33

7 years ago

2.0.0-32

7 years ago

2.0.0-31

7 years ago

2.0.0-30

7 years ago

2.0.0-29

7 years ago

2.0.0-28

7 years ago

2.0.0-27

7 years ago

2.0.0-2.0.0-26.debug.0

7 years ago

2.0.0-24

7 years ago

2.0.0-23

7 years ago

2.0.0-22

7 years ago

2.0.0-21

7 years ago

2.0.0-19

7 years ago

2.0.0-16

7 years ago

2.0.0-14

7 years ago

2.0.0-13

7 years ago

2.0.0-12

7 years ago

2.0.0-11

7 years ago

2.0.0-9

7 years ago

2.0.0-8

7 years ago

2.0.0-6

7 years ago

2.0.0-5

7 years ago

2.0.0-4

7 years ago

2.0.0-3

7 years ago

2.0.0-0

7 years ago