# mdx-starter

**Repository Path**: spaceman007/mdx-starter

## Basic Information

- **Project Name**: mdx-starter
- **Description**: This project is based on react, parceljs, mdx.
This project is a simple template project of which one can start easier.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-12-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 說明
- 這是一個基於 [reactjs](http://www.reactjs.org/), [parceljs](https://parceljs.org/) 和 [mdx](https://mdxjs.com) 的模板項目
- 使用 mdx 可以將 markdown 當作 react component 來使用
- markdown 中也可以嵌入普通 react component


# 構建步驟
## 1. package.json
parceljs 支持 mdx 的配置十分簡單，只需在 package.json 中添加如下的包即可:
```json
{
  "scripts": {
    "start": "parcel src/index.html --no-cache",
    "build": "parcel build src/index.html"
  },
  "dependencies": {
    "@mdx-js/tag": "^0.16.6",
    "react": "^16.7.0",
    "react-dom": "^16.7.0"
  },
  "devDependencies": {
    "@mdx-js/parcel-plugin-mdx": "^0.16.6",
    "parcel-bundler": "^1.11.0"
  }
}
```

## 2. scss
`yarn add sass --dev`

## 3. css-module
根據[文檔: postcss](https://parceljs.org/css.html#postcss)：
1. `yarn add postcss-modules`
2. 新建配置 `.postcssrc`，內容爲:
  ```json
  {
    "modules": true
  }
  ```