Giter Club home page Giter Club logo

docs-cn's Introduction

⚠️ Windi CSS is Sunsetting ⚠️
We are sunsetting Windi CSS and we recommend new projects to seek for alternatives. Read the full blog post.


Windi CSS Logo
Windi CSS

Npm Version Total Downloads Build Status Coverage
Discord Chat

Next generation utility-first CSS framework.

Why Windi CSS? 🤔

A quote from the author should illustrate his motivation to create Windi CSS:

When my project became larger and there were about dozens of components, the initial compilation time reached 3s, and hot updates took more than 1s with Tailwind CSS. - @voorjaar

By scanning your HTML and CSS and generating utilities on demand, Windi CSS is able to provide faster load times and a speedy HMR in development, and does not require purging in production.

Read more about it in the Introduction.

Integrations

Windi CSS provides first-class integrations for your favorite tools, select yours and get started.

Frameworks Package Version
CLI Built-in
VSCode Extension windicss-intellisense
Vite vite-plugin-windicss
Rollup rollup-plugin-windicss
Webpack windicss-webpack-plugin
Nuxt nuxt-windicss
Svelte svelte-windicss-preprocess
StencilJS stencil-windicssCommunity

Plugins 🛠

Check out plugins available for windicss.

Documentation 📖

Check the documentation website.

Discussions

We’re using GitHub Discussions as a place to connect with other members of our community. You are free to ask questions and share ideas, so enjoy yourself.

Contributing

If you're interested in contributing to windicss, please read our contributing docs before submitting a pull request.

Sponsors

Backers

License

Distributed under the MIT License.

docs-cn's People

Contributors

1wkk avatar alexanderniebuhr avatar antfu avatar arminmon avatar docschina-bot avatar elmassimo avatar hannoeru avatar harlan-zw avatar herberthe avatar huzhengen avatar keylxiao avatar kimyangofcat avatar kmq116 avatar lravaglia avatar megrax avatar mzaini30 avatar neelansh15 avatar qc-l avatar qwecxzpoi avatar reslear avatar robinvoor avatar salimabsi avatar sophie721 avatar steven-lay avatar techassi avatar tonyketcham avatar va3y avatar voorjaar avatar watonyweng avatar zheeeng 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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

docs-cn's Issues

词汇表

所有关于词汇的疑问,请在讨论区 #8 进行讨论。

此处收集已经确定的词汇表。

原文 译文
utilities 工具类
variants 可变修饰
effects 特效
preflights 预检样式
safelist 白名单

不需翻译的内容:

无需翻译
Windi CSS IntelliSense

翻译流程说明

翻译流程

本文档由 @docschina-bot 自动与英文文档同步更新,更新频次每天一次,更新时间为每周一早 6 点。因此,无需担心同步问题。

此流程遵循标准的 Github Flow,如已了解可直接略过。

Github Flow

整个翻译流程分为以下几个阶段:

  • 认领阶段
  • 翻译阶段
  • 校对阶段

认领阶段

如未认领文档就直接翻译,容易出现撞车的情况。

因此,在翻译前务必进行任务认领

认领任务,请到 Github Issues 选择想翻译的文档。翻译任务认领

选定要翻译的文档后,即可开始翻译。

翻译阶段

以 windicss 文档为例,如需对某篇文章进行翻译。

翻译过程中,请注意格式和内容的准确性。

fork 并 clone

先将 windicss/docs-cn 的文档仓库 fork 为个人仓库(有增删改的权限)。

将 fork 后的仓库 download 至本地,如:

git clone https://github.com/<YOUR-GITHUB-NAME>/docs-cn/

如下载过程过慢,可使用 depth 忽略以往的提交,这里不做过多赘述。

请基于 main 分支创建你的翻译分支(目的是,保证 main 分支与主仓库内容始终一致)。

例如:

git checkout -b <翻译分支> main

翻译

ps: 在开始翻译前,请务必先了解中文排版说明。

在 clone 好的文档中找到你所认领的文章,即可开始翻译。

翻译中请务必注意排版规范尽量不要让校对者在文档格式方面浪费时间

翻译完成后,请 push 至个人仓库。

git add
git commit -m 'docs(cn): 翻译的哪篇文章'
git push -u origin <翻译分支>

再创建 Pull Request 至 windicss/docs-cn 仓库。

注意:在创建 Pull Request 时,请尽量勾选允许其他人进行修改,便于快速修改及合并。

至此翻译阶段就结束了。

校对阶段

翻译完成请评论 @校对者

校对中,如有疑问或翻译错误,校对者会给出建议。

Github 的 PR 的评论提供了 suggestion 的功能,校对者对某行给出校对建议后,如无异议,可以直接进行合并。

而如果改动点较多,需进行本地修改时,则在本地对对应的内容进行修改,并提交到个人仓库的翻译分支即可。

注意: 无需关闭 Pull Request,Pull Reuquest 会自动追踪你的修改。

完成

校对完成后,校对者会对 PR 进行 Approve 操作,并进行 Pull Request 的合并。

当你的 Pull Request 被合并后,则代表流程结束。

其他

如需再次翻译,或同时翻译多篇。

  • 一次 pr 尽量只有一篇文章的翻译,便于回溯
  • 保证个人仓库的 main 分支始终为最新
  • 每次翻译新文章时,请基于 main 分支拉取新分支

更新个人仓库的分支

git remote add upstream https://github.com/windicss/docs-cn.git
git fetch upstream
git checkout main
git merge upstream/main

翻译流程

image

中文文档的锚点样式呈现有误

中文文档目前的标题效果时这样的:

配置 Windi CSS {#configuring-windi-css}

更详细的效果可以查看文档

但是 {#configuring-windi-css} 作为锚点信息,不是不应该渲染出来吗?正确的渲染效果可以参考 webpack 中文文档

出现这个问题的根本原因应该是两个仓库的静态文档生成器的渲染逻辑不同导致的,本仓库的 VitePress 并不支持这样添加锚点的方法。
我想到的解决方案有两种:

  1. 修改 VitePress 的渲染逻辑,支持这种添加锚点的语法。
  2. 不再手动添加锚点信息并且删除以前添加的锚点信息。

搜索不能使用

中文网上搜索不能使用,应该是昨天解决冲突的时候没有处理到。

翻译任务认领说明

翻译任务认领说明

注意:

  1. 一次尽量只认领一篇,给其他小伙伴留些机会~

  2. 认领开始前,请务必阅读 翻译流程说明

从 Todo List 中选取未被人领取过的文章:

未被领取过:

  • installation

领取过:

领取过,已完成:

领取方式,在本 issues 下评论即可。

认领任务格式:

Section | Title | 译者 | 完成时间 | PR
-- | -- | -- | -- | --
guide |  installation | @QC-L | 2021.05.18 - 2021.05.20 | -

示例效果:

Section Title 译者 完成时间 PR
guide installation @QC-L 2021.05.18 - 2021.05.20 -

当完成时,请修改自己的认领评论,添加 PR 信息:

Section Title 译者 完成时间 PR
guide installation @QC-L 2021.05.18 - 2021.05.20 #3

任务认领列表

Todo List:

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.