Skip to content

boenfu/hexo-renderer-react-styled

Repository files navigation

hexo-renderer-react-styled

😎 wow ~ use react + style-components write your hexo theme

Features

  • zero configure
  • import sub components directly
  • file extensions support .tsx .ts .jsx .svg .css
  • auto transform svg source file to react component by svgr

Example

  • theme directory example
└── your-theme
    ├── layout
    │   ├── components
    │   │   ├── header.tsx
    │   │   └── index.ts
    │   ├── index.tsx
    │   └── layout.tsx
    └── tsconfig.json
  • page view example
// index.tsx
import React, {FC} from 'react';
import styled from 'styled-components';
// import directly
import {Posts} from './components';
// see usage/svg
import Github from './icons/github.svg';
// see usage/css
import MarkdownCSS from './css/markdown.css';

const Index = styled.div`
  // ... css
`;

const Main = styled.div`
  // ... css
  ${MarkdownCSS}
`;

const Sidebar = styled.div`
  // ... css
`;

// Perfect type hint
const Component: FC<HexoComponentProps> = props => {
  const {page} = props;

  return (
    <Index>
      <Main>
        <Posts posts={page.posts} />
      </Main>
      <Sidebar>
        <Github />
      </Sidebar>
    </Index>
  );
};

export default Component;

Try it ?🙊

Usage

Installation:

yarn add hexo-renderer-react-styled # Or npm install --save hexo-renderer-react-styled

That's all, hexo will auto load

SVG

If need import ".svg" file, add module declare file for your project.

declare module '*.svg' {
  const fc: (props: any) => any;
  export default fc;
}

svgComplier will replace #000/#000000 to currentColor by default

CSS

If need import ".css" file, add module declare file for your project.

declare module '*.css' {
  const text: string;
  export default text;
}

usage example

import markdownCSS from './markdown.css';

const MarkdownContent = styled.div`
  ${markdownCSS}
`;

Who Use

License

MIT License.

About

Hexo renderer by react & styled-components

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published