# juejin-markdown-themes

**Repository Path**: pandafe/juejin-markdown-themes

## Basic Information

- **Project Name**: juejin-markdown-themes
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-10
- **Last Updated**: 2021-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 掘金 Markdown 主题

预览：https://xitu.github.io/juejin-markdown-themes/

## 使用方法

在文章内容前加上 [front matter](https://jekyllrb.com/docs/front-matter/) 格式的元信息：

```
---
theme: juejin
highlight: juejin
---
```

### Markdown 主题

使用 `theme` 指定主题

#### 内置主题

- [juejin](https://github.com/xitu/juejin-markdown-theme-default)
- [github](https://github.com/sindresorhus/github-markdown-css)

#### 社区主题

| 主题 | 作者 |
| --- | --- |
| [smartblue](https://github.com/cumt-robin/juejin-markdown-theme-smart-blue) | [掘金](https://juejin.im/user/2752832847753085) [GitHub](https://github.com/cumt-robin) |
| [cyanosis](https://github.com/linxsbox/juejin-markdown-theme-cyanosis) | [掘金](https://juejin.im/user/3175045313873943) [GitHub](https://github.com/linxsbox) |
| [channing-cyan](https://github.com/ChanningHan/juejin-markdown-theme-channing-cyan) | [掘金](https://juejin.im/user/2101921963839678) [GitHub](https://github.com/ChanningHan) |

### 代码高亮

使用 `highlight` 指定主题，可以使用 [highlight.js](https://github.com/highlightjs/highlight.js) 中的所有样式：

- [样式列表](https://github.com/highlightjs/highlight.js/tree/master/src/styles)
- [样式预览](https://highlightjs.org/static/demo/)

## 如何贡献 Markdown 主题

1. 使用[默认模板](https://github.com/xitu/juejin-markdown-theme-default)创建一个公开的仓库（点击绿色的 Use this template 按钮）
2. 将其中的 `juejin.scss` 替换为自己创作的样式，目前支持 Sass，Less 和 CSS
3. Fork 此仓库并克隆到本地，在 `themes.js` 文件中指明样式文件的路径，`ref` 为 commit hash
4. 在 `README.md` 中「社区主题」章节中添加你的主题和作者信息
5. 提交 pull request

## License

MIT