Điểm qua pedronauck/docz: 23.6k sao trên GitHub, viết chủ yếu bằng TypeScript, thuộc nhóm UI / UX. ✍ It has never been so easy to document your things!
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Docz makes it easy to write and publish beautiful interactive documentation for your code.
Create MDX files showcasing your code and Docz turns them into a live-reloading, production-ready site.
Why?
Documenting code is one of the most important and time-consuming tasks when developing software.
A lot of time is spent on building and maintaining custom documentation sites.
Docz enables you to quickly create a live-reloading, SEO-friendly, production-ready documentation site with MDX and customize the look, feel and behavior when required by leveraging GatsbyJS and Gatsby theme shadowing.
Getting started
Start by adding docz as a dependency to your project with Yarn or npm:
import React from 'react'
import t from 'prop-types'
const Button = ({ children, type }) => <button type={type}>{children}</button>
Button.propTypes = {
/**
* This is a description for this prop.
* Button type.
*/
type: t.oneOf(['button', 'submit', 'reset']),
}
Button.defaultProps = {
type: 'button',
}
export default Button
Finally, run:
yarn docz dev
This starts a local development server and opens your documentation site in the browser.
Build
yarn docz build generates a static site in .docz/dist/.
Try it with yarn docz serve or by serving the generated site with your favorite static file server (e.g. npx serve .docz/dist).
You can have yarn docz build emit to a different directory by providing a path to the dest field in your doczrc.js or from the command line: yarn docz build --dest docs-site-directory.
Deploying
The output of docz consists of static assets only.
This allows you to deploy your generated docz site with any static site hosting provider you'd like.
Start by building your site with yarn docz build, if you haven't provided a dest flag to your config then you will find your generated files in .docz/dist to copy to the server.
Examples
with basic
with a gatsby site
with react native
with styled-components
with typescript
with algolia search
with gatsby-remark-vscode
with react-router
with flow
with images
with sass
with less
with stylus
with css modules: works out of the box.
You can check the complete list of docz examples here.
Used by
Welcome UI: Customizable design system with react • styled-components • styled-system and reakit.
React Hooks Testing Library: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.
Mobx React: mobx-react documentation site.
React Google Charts: A thin, typed, React wrapper over Google Charts Visualization and Charts API.
Entur: Entur operates the national registry for all public transport in Norway.
FAB Specification: 💎 FABs are a compile target for frontend applications.
@umijs/hooks: React Hooks Library.
React Yandex Maps: Yandex Maps API bindings for React.
Components-extra: Customizable react component blocks built with material-ui and styled-components.
Add your site
Contributors
This project exists thanks to all the people who contribute. [Contribute].
Contributing
All kinds of contributions are very welcome and appreciated!
If you want to contribute time to docz then here's a list of suggestions to get you started:
Star the project on GitHub.
Help people in the issues by sharing your knowledge and experience.
Find and report issues.
Submit pull requests to help solve issues or add features.
Influence the future of docz with feature requests.
If you're looking for a place to start make sure to check issues tagged with the good first issue label:
Read the Contributing Guide before you open a pull request.
You can also sponsor us via OpenCollective to help secure docz's future.
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/pedronauck/docz là nguồn chính thức.
pedronauck/docz có bao nhiêu sao?
pedronauck/docz có 23.6k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/pedronauck/docz. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.