next-static-pages

Module that makes NextJS static pages like markdown easier to display.

Usage no npm install needed!

<script type="module">
  import nextStaticPages from 'https://cdn.skypack.dev/next-static-pages';
</script>

README

Next Static Pages

Modest helper module for easily rendering static files such as HTML or Markdown content in NextJS. NSP exports the required methods needed to load your static paths and props making the rendering of said content rather simple.

For more on generating static content please see Static Generation.

Getting Started

From your terminal install NSP for use in your project.

npm install next-static-pages

OR

yarn add next-static-pages

Create Directory

Create a directory you wish to use that will contain your static content. By default the options look for the directory /statics relative to the root of your project. You can specify multiple directories if you wish in options.directories.

Within your /pages directory create the directory /pages/statics. Create an index file within that directory.

Rendering Static Links

In the above /pages/statics/index.tsx (or it may be .jsx) page copy and paste the following component. Take note of the { mode: 'resolved' } options that's set. This tells NSP to return the resolved path configs which we're using to create our links with.

import { FC } from 'react';
import nsc, { IResolvedProps } from 'next-static-pages';
import Link from 'next/link';

// Note setting "mode" here to "resolved" this will case our
// resolved path configurations to be returned in props.
const { getStaticPaths, getStaticProps } = nsp({ mode: 'resolved' });

const MyComponent: FC<IResolvedProps> = ({ resolved }) => {

  // We iterate the array of configs and build Next Links for navigation.
  return (
    <ul style={{ listStyle: 'none', margin: 0, padding: 0 }}>
      {resolved.map(r => {

        // Create our href or link and a prettier looking label for the anchor.
        const href = `/statics/${r.slug}`;
        const label = r.slug.split('-').map(v => v.charAt(0).toUpperCase() + v.slice(1)).join(' ');

        return (
          <li key={r.slug}>
            <Link href={href}>
              <a>{label}</a>
            </Link>
          </li>
        );

      })}
    </ul>
  );

};

// DO NOT FORGET TO EXPORT THESE!!!
export { getStaticPaths, getStaticProps };
export default MyComponent;

Rendering Static Content

Now that we have a directory and index with your links to our static files/pages we need a way to consume the rendered content.

Create a file in /pages/statics called [slug].tsx. This will be a dynamic page that we'll match up our above created links with.

For example if we have a file that was named 05-25-2021.md and it's physical path is /statics/05-25-2021.md then our above component would create the route /statics/05-25-2021.md which would be picked up by our dynamic component that we're defining here as [slug].tsx.

if you want to use [id].tsx instead of slug (or some other param name) just be sure to update the param key option { paramKey: 'id' }. Initializing NSP would then look like:

const { getStaticPaths, getStaticProps } = nsp({ paramKey: 'id' });

If this doesn't quite make sense head over to NextJS Dynamic Routes documentation.

import { FC } from 'react';
import nsc, { IRenderedProps } from 'next-static-pages';

const { getStaticPaths, getStaticProps } = nsp(); 

// data: any gray matter metadata you passed if any in your markdown file.
// content: the string to be injected as shown below.

const MyComponent: FC<IRenderedProps> = ({ data, content }) => {
  return (
    <div dangerouslySetInnerHTML={{ __html: content }} />
  );
};

export { getStaticPaths, getStaticProps };
export default MyComponent;

Syntax Highlighting (using highlight.js)

NSP supports syntax highlighting which often is required when serving static markdown files as they can contain code syntax. Similar to this very README file.

Currently highlighting is use "auto" mode. The only thing you need to do to enable highlighting is to set the option to true and import a style that you wish to use.

// import the desired style.
import 'highlight.js/styles/an-old-hope.css';

// Set highlight to true.
const { getStaticPaths, getStaticProps } = nsp({ highlight: true });

See more on highlight.js

NOTE: for convenience we've included highlight.js in this library however in the future we'll probably pull this out so that more efficient important of only the required languanges can be provided.

Using Locales

NSP supports locale sub directories for displaying localized pages/files. When defining your directories in your options simply define a sub folder with your locale prefixes. See below where the root folder is content and the Spanish locale, denoted by es is nested below it.

To use locales you should head over to the NextJS Localization documentation but the basic setup would be defined something similar to the below example in your next.config.js

module.exports = (phase, { defaultConfig }) => {
  // ensures webpack 5
  defaultConfig.future.webpack5 = true; 
  return {
    // spread the default config.
    ...defaultConfig, 
    webpack: (config, { isServer }) => {
      // modify webpack here then return the config.
      return config;
    },
    // Define localization.
    i18n: {
      locales: ['en-US', 'es'],
      defaultLocale: 'en-US'
    }
  };
}

Options

For a list of options, their defaults and their function head over to the Api Docs Options for more information.

Issues Importing Node Modules

If you notice an error similar to the below, not to worry. This is related to a code splitting issue. This error is raised because NextJS is trying to import a NodeJS module in the browser context which is not possible. When you export these two static methods either in your Functional Component or Component Next will then correction import fs/promises for example in the server context.

Easy Fix

Simply add the static exports and Next will no longer complain!

export { getStaticPaths, getStaticProps };

Api Docs

See https://blujedis.github.io/next-static-pages/

Change

See CHANGE.md

License

See LICENSE.md