Code Monkey home page Code Monkey logo

bisheng-antd-doc-template's Introduction

对Antd文档管理做了一下抽离简化Antd文档管理主题

antd 的文档系统有什么优点

  • 首先基于antd团队成员开发的博客服务 https://github.com/benjycui/bisheng
  • 其次漂亮的界面 用来管理文档很合适
  • 最主要的优点是。。他会把markdown里面的特定代码转换成页面包括react

我自己在博客上面的应用

配置文件

vi site/bisheng.config.js

主题的一些配置

antd的文档界面一些配置

  • 编译的配置文件是在 site/bisheng.config.js
  • 路由的一些配置是在 site/theme/index.js
  • 中文菜单配置 site/theme/zh-CN.js
  • 英文菜单配置 site/theme/en-US.js

使用方式

npm start

写文档方式

创建文档

  • 在components文件目录下创建组件文件夹(注意不能带大写) helloworld
cd components
mkdir helloworld
  • 创建文件index.zh-CN.md(这里的zh-CN表示中文文档, 如果换成en-US的话表示英文文档)
echo "" > index.zh-CN.md
  • 写入内容
---
title: HelloWorld
subtitle: hello
---

Hello world

创建文档demo

  • 在helloworld 文件里面创建文件夹demo并创建文件alert.md
mkdir demo
cd demo
echo "" > alert.md
  • 向alert.md写入内容

内容样例

改完后需要重新启动

npm start

TODO

感谢Antd的开源

bisheng-antd-doc-template's People

Contributors

wuguanghai45 avatar

Watchers

James Cloos 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.