@seihon/sectionize

Seihon【製本】(Bookbinding in Japanese) is a JavaScript toolkit that improves your MDX transformation pipeline. It allows you to quickly transform MDX documents into a collection (like turning codices into book).

More importantly, this toolkit is the last piece of the puzzle that enables code-splitted CMS-less MDX-based static site generation.

@seihon/sectionize is a unified plugin that divides a continuous piece of text into chunks wrapped by a customizable tag.

• To use it with @mdx-js/loader, you can add it to the remarkPlugins option.

• To use it with unified, you just need to place this plugin into the .use() pipeline.

In most occasions, you need to use this plugin together with unified, or @mdx-js/loader and babel-loader.

Usage

This is an example of using @seihon/section alone. For a complete example of the entire Seihon toolkit, please refer to the main README.md.

// webpack.config.js
import sectionize from '@seihon/sectionize';
// ...
module: {
  rules: [
    {
      test: /\.mdx?$/,
      use: ['babel-loader', '@mdx-js/loader', '@seihon/loader']
    }
    // ...
  ];
}

// src/content/posts/introducing-seihon.mdx

# Introducing Seihon

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

## Overview

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

- Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

// src/components/post.jsx
import React from 'react';
import { MDXProvider } from '@mdx-js/react';
import Article from '../content/posts/introducing-seihon.mdx';

export default function Post() {
  return (
    <MDXProvider>
      <Article />
    </MDXProvider>
  );
}

Using the above config, you would obtain the following react rendering output.

<section>
  <h1>Introducing Seihon</h1>
  <p>
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
    tempor incididunt ut labore et dolore magna aliqua.
  </p>
</section>
<section>
  <h1>Overview</h1>
  <p>
    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
    aliquip ex ea commodo consequat.
  </p>
</section>
<section>
  <ul>
    <li>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur.
    </li>
    <li>
      Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
      deserunt mollit anim id est laborum.
    </li>
  </ul>
</section>

Support

This library has been continuously used in many of my personal projects, and is regarded as production-ready. In the foreseeable future, I will continuously maintain and support this library.

Issues and Feedback

Please voice your opinion and report bugs in the issues sections of this GitHub project.

Contributing

You are more than welcome to add more functionalities, improve documentation, fix bugs, and anything you think is needed. The build step is pretty self-explanatory. Please refer to CONTRIBUTING.md for more details.

License

MIT