catalog

Create living style guides using Markdown or React
styleguide style guide docs documentation react markdown


Summary

Project Name catalog Project Url https://www.catalog.style/
InceptionYear 2013-09-05 20:37:02 更新时间 2018-10-08 20:36:57
IssueManagement https://github.com/interactivethings/catalog/issues Licenses BSD-3-Clause
仓库地址 git+https://github.com/interactivethings/catalog.git 用户数 4
Node Engine 文件大小 788.8 KB
install preversion prepublishOnly precommit prettier-all

项目介绍

![Catalog Logo](https://interactivethings.github.io/catalog/docs/assets/catalog_logo.svg) [![Travis](https://img.shields.io/travis/interactivethings/catalog.svg)](https://travis-ci.org/interactivethings/catalog/) [![Downloads](https://img.shields.io/npm/dm/catalog.svg)](https://www.npmjs.com/package/catalog) [![Version](https://img.shields.io/npm/v/catalog.svg)](https://www.npmjs.com/package/catalog) [![License](https://img.shields.io/npm/l/catalog.svg)]() # Catalog Catalog lets you create beautiful living and fully interactive style guides using Markdown and React components. Please read the [Catalog documentation](https://docs.catalog.style/) (built with Catalog!) for detailed installation and usage instructions. ## Installation ### yarn ``` yarn add catalog react react-dom ``` ### npm ``` npm install catalog react react-dom --save ``` ## Development > Please make sure that you have Node >= 6 and [yarn](https://yarnpkg.com/) installed. ### Build process Start the build process in watch mode: ``` make ``` ### Docs To edit Catalog documentation, run: ``` make docs ``` > Note: this uses the local Catalog build from `dist/`. Run `make` before/alongside `make docs`. ### Linking When developing Catalog you want to link it locally: ``` yarn link ``` You can then link to this version in your project (or one of the examples): ``` yarn link catalog ``` ### Tests To run [Jest](https://facebook.github.io/jest/) tests in watch mode: ``` make test-watch ``` ## Creating a Release Bump Catalog's version: ``` make version ``` Then push including tags: ``` git push && git push --tags ``` The CI server will automatically run tests, build and publish the new version to npm ## CI commands > These usually run automatically on the CI server ### Create a build ``` make build ``` ### Create a documentation build ``` make build-docs ``` ### Publish to npm and generate GitHub release notes ``` make publish ``` ## Credits Catalog is developed by [many people](https://github.com/interactivethings/catalog/blob/master/AUTHORS) at [Interactive Things](https://www.interactivethings.com/), a User Experience and Data Visualization Studio based in Zürich.

Dependencys

GroupId ArtifactID Version 引用量
leo args 5.0.1 297
Andrey Sitnik autoprefixer 9.8.0 31988
Sebastian McKenzie babel-core 6.26.3 1211
Luis Couto babel-loader 8.1.0 106364
Kye Hohenberger babel-plugin-emotion 10.0.33 868
danez babel-plugin-syntax-dynamic-import 6.18.0 1525
danez babel-plugin-transform-object-rest-spread 6.26.0 16493
Sebastian McKenzie babel-polyfill 6.26.0 18839
James Kyle babel-preset-flow 6.23.0 3470
Sebastian McKenzie babel-preset-react 6.24.1 33518
fb babel-preset-react-app 9.1.2 6653
Sebastian McKenzie babel-runtime 6.26.0 18894
Daniel Lo Nigro babel-standalone 6.26.0 299
qix chalk 4.0.0 66811
Kye Hohenberger create-emotion 10.0.27 35
brianvaughn create-react-class 15.6.3 439
Tobias Koppers @sokra css-loader 3.5.3 68110
Mike Bostock d3-color 1.4.1 309
fengmk2 detect-port 1.2.3 821
Tobias Koppers @sokra extract-text-webpack-plugin 3.0.2 17910
Tobias Koppers @sokra file-loader 6.0.0 39973
Geoffroy Warin friendly-errors-webpack-plugin 1.7.0 6096
Dan Flettre github-slugger 1.3.0 187
Michael Jackson history 4.10.1 4190
Jan Nicklas html-webpack-plugin 4.2.2 38680
Vladimir Zapparov js-yaml 3.14.0 11059
Christopher Jeffrey marked 1.1.0 7425
Andrey Sitnik postcss-loader 3.0.0 11830
Lea Verou prismjs 1.20.0 2791
acdlite prop-types 15.7.2 23684
Chris Dickinson raf 3.4.1 3156
Scott Sauyet ramda 0.27.0 7471
Tobias Koppers @sokra raw-loader 4.0.1 9048
fb react-dev-utils 10.2.1 6007
Dan Abramov react-document-title 2.0.3 324
React Training react-router 5.2.0 7448
Jimmy Jia react-router-scroll 0.4.4 80
Rich Harris sander 0.6.0 130
Sindre Sorhus srcset 2.0.1 25
Sindre Sorhus strip-indent 3.0.0 286
Tobias Koppers @sokra style-loader 1.2.1 53631
developit unfetch 4.1.0 237
Tobias Koppers @sokra url-loader 4.1.0 31243
Tobias Koppers @sokra webpack-dev-server 3.11.0 57039
Dane Thurber webpack-manifest-plugin 2.2.0 4929

开发依赖

GroupId ArtifactID Version 引用量
Sebastian McKenzie babel-cli 6.26.0 958
Sebastian McKenzie babel-eslint 10.1.0 94536
aaronabramov babel-jest 26.0.0 40165
danez babel-plugin-external-helpers 6.22.0 6311
Vyacheslav Slinko babel-plugin-react-require 3.1.3 390
Henry Zhu babel-preset-env 1.7.0 41552
Nicholas C. Zakas eslint 7.1.0 210686
Simon Lydell eslint-config-prettier 6.11.0 30577
Yannick Croissant eslint-plugin-react 7.20.0 62848
Sindre Sorhus flow-bin 0.125.0 12589
Typicode husky 4.2.4 45562
aaronabramov jest 26.0.0 107517
Andrey Okonetchnikov lint-staged 10.2.5 31806
James Long prettier 2.0.5 70619
acdlite react 16.13.1 112006
acdlite react-dom 16.13.1 88292
leo release 6.1.0 106
Rich Harris rollup 1.6.1 29272
Rich Harris rollup-plugin-babel 4.4.0 28708
Rich Harris rollup-plugin-commonjs 10.1.0 19914
Rich Harris rollup-plugin-node-resolve 5.1.1 20489
Rich Harris rollup-plugin-replace 2.2.0 4848
Bogdan Chadkin rollup-plugin-terser 6.1.0 10298
Rich Harris rollup-watch 4.3.1 2283