Configuration
Nocturne ships pre-configured. But you'll want to make it yours.
This section covers every configuration file in Nocturne:
| File | What It Controls |
|---|---|
docusaurus.config.ts | Site title, URL, theme, plugins |
sidebars.ts | Sidebar structure |
static/admin/config.yml | Decap CMS admin panel |
src/data/*.json | Homepage, navbar, widgets, site info |
Edit these files directly in a text editor. Or use Decap CMS for the JSON data files.
What You Need to Know
Before you start configuring Nocturne, understand this:
TypeScript Files
docusaurus.config.ts and sidebars.ts are TypeScript files. You edit them in a text editor, then run npm start to see the changes.
JSON Files
src/data/*.json are JSON files. You can edit them in a text editor — or through Decap CMS at /admin/.
YAML File
static/admin/config.yml is a YAML file for Decap CMS. Edit it in a text editor.
Configuration Order
If you're configuring Nocturne for the first time, follow this order:
docusaurus.config.ts— set your site title, URL, and metadatasrc/data/site.json— set your product identitysrc/data/navbar.json— set navigation linkssrc/data/home.json— set homepage contentsrc/data/widgets.json— set sidebar widgetssidebars.ts— structure your documentationstatic/admin/config.yml— set up Decap CMS
What You Can Configure
| Section | File | Purpose |
|---|---|---|
| Docusaurus Config | docusaurus.config.ts | Site identity, theme, plugins |
| Sidebar Config | sidebars.ts | Documentation structure |
| Decap CMS | static/admin/config.yml | Admin panel configuration |
| Data Files | src/data/*.json | Homepage, navbar, widgets |
What's Next?
Start with the most important config file — Docusaurus.