Dictc generates a documentation website for your React Component library.
Typescript supported only at present
$ yarn add dictc --dev
or
$ npm install dectc --save-dev
-
Create a folder named
.dictcin the root directory of your project -
Create a file named
dictc.config.jsindictc. -
Config your app.
# source tree
.
├── .dictc
│ └── dictc.config.js
└── src
├── components
│ ├── Button
│ │ ├── Button.tsx
│ │ ├── index.md
│ │ └── index.tsx
│ └── Icon
│ ├── index.md
│ └── index.tsx
└── index.ts
// .dictc/dictc.config.js
module.exports = {
// Default to "Documentation"
title: 'Title',
footerText: 'Copyright Company 2018 - Project',
// Dictc import components used in the documentation from the context directory
context: 'src',
// Customized style file
styleFile: 'src/styles/index.less',
// Define your pages and contents
sections: [
{
// This shows in the side menu
name: 'Get Started',
// Single markdown file, use "contentPath"
contentPath: 'README.md'
},
{
name: 'Components',
// dictc automatically resolve components in this path
// dictc searches for "index.md"
resolvePath: 'src/components/'
}
]
};- Run
yarn run dictc. You can also add this command to yourpackage.json
dictc is still at development. Feel free to contribute to this project.