Skip to content
TypeScript JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src
webpack
.editorconfig
.gitattributes
.gitignore
.npmignore
.prettierrc
README.md
package.json
template.ejs
tsconfig-compile.json
tsconfig-node.json
tsconfig.json
yarn.lock

README.md

Doc Frame

Common UI for docs page.

Previews http://fe.jimu.io/doc-frame/

Usage

yarn add --dev @jimengio/doc-frame
  • DocSidebar
import { DocSidebar, ISidebarEntry } from "@jimengio/doc-frame";

let docItems: ISidebarEntry[] = [
  {
    title: "Demo 1",
    cnTitle: "例1",
    path: "demo1",
  },
  {
    title: "Demo 2",
    cnTitle: "例2",
    path: "demo2",
  },
];

<DocSidebar items={docItems} currentPath={path} onSwitch={(item) => setPath(item.path)} />;
  • DocBlock

Markdown content rendered into block. When embed mode is activated, all borders and margins are removed:

<DocBlock content="markdown content" embed></DocBlock>
  • DocDemo

A card container with title and link:

<DocDemo title="Demo of demo" link={"TODO"}>
  <div>The demo</div>
</DocDemo>
  • DocSnippet
<DocSnippet code={code} lang={"typescript"} />

Workflow

https://github.com/jimengio/ts-workflow

License

MIT

You can’t perform that action at this time.