Giter VIP home page Giter VIP logo

components's Introduction

๐ŸŒฟ Mintlify Connector

Stars Twitter

Mintlify helps teams easily track and manage documentation.

๐Ÿš€ Get Started

๐ŸŽฅ Demo

๐Ÿ”— Create links between code and documentation

Connect documentation to code and receive alerts to update your documentation when the code changes

๐Ÿ”Œ Integrations

We are currently integrated with:

  • Notion
  • Google Docs
  • Confluence
  • GitHub
  • Slack

More information

Website Twitter Discord

Built with ๐Ÿ’š by the Mintlify team

components's People

Contributors

benjamin-shen avatar dependabot[bot] avatar ghoshnirmalya avatar hahnbeelee avatar handotdev avatar limo1996 avatar nicozweifel avatar sboy99 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

components's Issues

Support Global Sync for `<Tabs>` Components

Support global groups in <Tabs> components to allow switching all tab groups on a page to a particular tab in one click.
This can be useful for setup instructions with multiple platforms or libraries that support multiple options.
For example, choosing a platform (say Web modular API) in the firebase docs switches all tab components to Web modular API so the user doesn't have to make the same selection over and over again.

This can be implemented with an optional tabs-group prop on the <Tabs> component, and an optional tab-id prop on the <Tab> component that defaults to title prop if the parent <Tabs> component has tabs-group set.

Support images in the Card icon prop type

Images are already rendered correctly but the types need to be updated.

For reference: Images will only render correctly on Mintlify if the file paths are absolute. Relative file paths are not resolved correctly in production. We are working on that MDX parsing problem in the mint repo.

Cards should accept an image prop

Summary

Card right now only accepts icons. However, a true Card should have an image property that sits above the card and covers the entire spacing like so

CleanShot 2023-02-07 at 23 03 30@2x

Combine copiedTooltipColor and tooltipColor

We tried using separate colors in mint for the code block's copy tooltip but it looked odd having the color change when you click.

We should use the same hex color for both and delete the copiedTooltipColor prop.

Mermaid.js component

Mermaid is an excellent, markdown-powered diagramming tool that allows authors to user journeys, flowcharts, class diagrams, and more directly from their own markdown codeblocks. Gitlab has integrated with mermaid to allow for the generation of charts in issue descriptions and comments, and our team uses it very often.

We'd love to see mermaid integrated into Mintlify, and added bonus if it automatically matches the theme colors and fonts from the rest of the documentation website. It would be a great way to easily integrate graph and flow chart features into more complex documentation that is otherwise hard to maintain.

https://mermaid.js.org/

Make a ColorFrame component

Goal

Our callouts always have an icon.

We want to let users make a frame without an icon.

You can use the Callout Template code and pass different props to it.

Schema

<ColorFrame borderColor={hexcode} backgroundColor={hexcode} />

Tree-shaking

None of the primary maintainers of this repo are experts in tree-shaking. We would appreciate someone taking a look and making sure tree-shaking is set up correctly. The package has a lot of components and we don't want them being imported on pages that don't use them.

Make components to show images side by side

Developers frequently need to show images side by side. That's fine on regular websites but manually specifying widths and padding is annoying when you just want to write docs.

We want to provide components that lets Mintlify users show multiple images side by side taking up equal amounts of space. For example:

<ImageRow count={2}>
  <img />
  <img />
</Row>

Should show two images side by side like on this page. The HTML for those two images is:

<div className="flex flex-row justify-between">
  <img src="/img/activity_small.png" width={"48%"} />
  <img src="/img/sleep_small.png" width={"48%"} />
</div>

However, we cannot directly modify child components inside the proposed ImageRow component. Whoever attempts this could use the children: variant to modify the CSS of Row's children like we do in CodeBlock

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.