Git Product home page Git Product logo

docs's Introduction

Mix Space Documentation

Contributing 贡献

这个站点使用的是 Nextra 程序。站点内容使用 MDX 编写,文档文件都在 pages 文件夹中。如果只有一些简单的修改,你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.

在本地开发中,pnpm 被选用为项目的包管理器,你需要使用 pnpm 安装依赖:

pnpm i
pnpm run dev
pnpm run build
pnpm run start

Working on the content 修改文字

  • 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力,请参阅 Nextra 文档
  • 有关编写和维护文档内容的规则和建议,请参阅编写指南。

Guide 编写指南

新增一个章节

  1. 克隆此项目
  2. page 文件夹中,新增一个文件夹,请语义化命名,假设为 test
  3. 编写内容,具体可以借鉴其他文档文件夹,请务必设置了父文件夹的 _meta.json 文件,具体请参考 Nextra 文档
  4. 创建 Pull Request. 其余审核的事情只需要交给我们来做就好了

编写内容的时候需要注意的事情

  1. 中文与英文之间请保留一个空格,如测试 test 测试

Author

docs © Mix Space Team, Released under MIT. Created on Jul 9, 2023

docs's People

Contributors

wibus-wee avatar innei avatar wuhang2003 avatar zach677 avatar renovate[bot] avatar zhuozhiyongde avatar rdp-studio avatar raykr avatar ttimochan avatar palomiku avatar miaoermua avatar mitian233 avatar

Stargazers

 avatar

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.