Atomize

A static documentation site generator based on the Atom One Dark & Light theme.

Features:

• 📃 Write docs with .mdx
• 🌜 Dark mode support with next-themes
• ✏️ Automatic code highlighting of code blocks and inline code snippets with shiki and mdx-pretty-code
• 🚢 Easy deployment to GitHub pages with GitHub Actions

This project contains everything needed to start creating a beautifull documentation site.

Installation

Atomize requires Node >= 14

GitHub Template

Create a reopo from this template on GitHub

Clone to local

You can also use create-next-app with:

# With npm
npx create-next-app -e https://github.com/LukasCornille/atomize

# With yarn
yarn create next-app -e https://github.com/LukasCornille/atomize

Checklist

After you've created a new project, follow these steps to ensure to update the project' info with this checklist

• Change the author name in LICENSE
• Change the title in index.tsx
• Change the favicon in public
• Enable GitHub pages for your repo
• Clean up the README and pages

That's it, have fun!

Usage

Development

Run the following command and visit http://localhost:3000

npm run dev

Production

To get a working production site run:

npm run build