https://github.com/gbombassaro/prensa-docs

Repositório de componentes para documentação de projetos em JSX/MDX.
https://github.com/gbombassaro/prensa-docs

designsystem jsx mdx prensa react reactjs storybook

Last synced: 22 days ago
JSON representation

Repositório de componentes para documentação de projetos em JSX/MDX.

• Host: GitHub
• URL: https://github.com/gbombassaro/prensa-docs
• Owner: gbombassaro
• Created: 2020-10-07T01:54:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-05T00:12:39.000Z (about 3 years ago)
• Last Synced: 2024-11-15T22:57:22.362Z (about 2 months ago)
• Topics: designsystem, jsx, mdx, prensa, react, reactjs, storybook
• Language: JavaScript
• Homepage: http://docs.prensadesign.com.br
• Size: 128 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## PRENSA-DOCS

É um repositório de componentes para documentação em JSX/MDX.

Para instalação, utilizar o comando `npm install prensa-docs`.

No projeto existem 3 componentes básicos para documentação:

- CodeBlock

- CSSTable

- Space

### CodeBlock

É um componente para a exibição de códigos JSX. Para utiliá-lo basta importar ele no arquivo desejado e utilizar a props children passando uma string com o código desejado.


  import CodeBlock from 'prensa-docs';



``


### CSSTable

É um componente casca para uma tabela de dados. Sua função é documentar as classes de estilo para reescrita no código, caso necessário. Para utiliálo, basta enviar uma lista de objetos com o seguinte formato:


  import {CSSTable} from 'prensa-docs';


  const rows = [

    {

      id: 'id único para cada entrada',

      class: 'nome de classe do css',

      tokens: 'valor de token, se houver'

    }

  ]



``


### Space

É um componente para espaçamento no MDX. Ele usa o estilo inline com a unidade de espaçamento 8px. Para utilizá-lo, deve-se passar um número para a props size: `size={1}` resulta em 8px de espaçamento.


  import {Space} from 'prensa-docs';



``