0.3.0 • Published 6 years ago
dictc v0.3.0
dictc
Dictc generates a documentation website for your React Component library.
Typescript supported only at present
Get started
Installation
$ yarn add dictc --dev
or
$ npm install dectc --save-dev
Configuration
Create a folder named
.dictc
in the root directory of your projectCreate a file named
dictc.config.js
indictc
.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
Caveats
dictc is still at development. Feel free to contribute to this project.
0.3.0
6 years ago
0.2.1
6 years ago
0.2.0
6 years ago
0.1.0
6 years ago
0.0.10
6 years ago
0.0.9
6 years ago
0.0.8
6 years ago
0.0.7
6 years ago
0.0.6
6 years ago
0.0.5
6 years ago
0.0.4
6 years ago
0.0.0-alpha.0
6 years ago
0.0.3
6 years ago
0.0.2
6 years ago
0.0.2-alpha3
6 years ago
0.0.2-alpha2
6 years ago
0.0.2-alpha1
6 years ago
0.0.1
6 years ago
0.0.0
6 years ago