Second Star Docs - Beautiful Documentation Platform
Complete documentation platform with Think Neverland branding, optimized for Railway.com deployment
Table of Contents
Second Star Docs ⭐
"Second star to the right, straight on 'til documentation"
Welcome to Second Star Docs - the most beautiful and effortless documentation platform for developers who refuse to grow up. Built with Think Neverland's magical touch and optimized for Railway.com deployment.
✨ Why Choose Second Star Docs?
- 🚀 Zero Configuration: Drop markdown files and you're ready to fly
- 🎨 Beautiful Design: Clean, modern interface with automatic dark mode
- 🚂 Railway Ready: Deploy to Railway.com in minutes with one-click setup
- 📱 Mobile Perfect: Responsive design that works on any device
- 🔍 Smart Navigation: Auto-generated sidebar from your file structure with professional, clean display
- ✨ Clean Navigation Display: Automatically strips emojis and markdown syntax for polished appearance
- 🎯 Single-Page Sections: Sections with only one page display as direct links (no unnecessary dropdowns)
- 🧠 Smart Section Detection: Single markdown files automatically serve as section indices
- 📂 Auto-Generated Indexes: Directories without index files automatically show professional listings
- 📝 Flexible Home Pages: Support for both
home.md/index.md(markdown) andhome.html/index.html(full HTML/CSS) - ⚡ Lightning Fast: Built with Next.js 14 and optimized for performance
- 🎭 Custom Branding: Full control over colors, logos, and styling
- {{}} Dynamic Placeholders: Content injection with
{{AUTO_DOCS}},{{SITE_NAME}}, and more (works in both HTML and markdown) - 🔧 Developer Friendly: Built by developers, for developers
🚀 Quick Start
Get your documentation site flying in just 3 steps:
1. Clone & Install
git clone https://github.com/thinkneverland/second-star-docs.git
cd second-star-docs
npm install
⟩
2. Add Your Content
Drop your markdown files into /public/docs/. This very site demonstrates the complete book structure:
/public/docs/
├── getting-started/ # Chapter 1: Getting Started
│ ├── index.md # Chapter overview
│ ├── installation.md # Installation guide
│ ├── file-structure.md # File organization
│ ├── basic-setup.md # Basic configuration
│ ├── first-pages.md # Creating content
│ └── markdown.md # Markdown features
├── features/ # Chapter 2: Features
│ └── index.md # Complete feature overview
├── deployment/ # Chapter 3: Deployment
│ └── index.md # Railway & platform guides
├── customization/ # Chapter 4: Customization
│ └── index.md # Branding & styling
├── advanced/ # Chapter 5: Advanced
│ └── index.md # Performance & API reference
├── support/ # Chapter 6: Support
│ └── index.md # FAQ & troubleshooting
└── home.md # Custom home page
💡 This IS Second Star Docs: You're looking at a live example! Browse through the chapters above to see how we've structured our own documentation from basic setup to advanced features.
3. Deploy to Railway
🎉 What's New
Latest Features
Single-Page Section Navigation ⭐ New!
- Sections with only one page display as direct links (no dropdown arrows)
- Cleaner, more intuitive navigation UX
- Reduces unnecessary clicks for simple sections like "Getting Started" or "About"
- Automatically adapts when you add or remove files
- Smart detection: 1 page = direct link, 2+ pages = expandable dropdown
Navigation Flattening for Single-File Directories ⭐ New!
- Single-file directories automatically display as direct links in the navigation
- Example: "Advanced - Caching" instead of an expandable "Advanced" section
- Eliminates unnecessary clicking for simple sections
- Automatically switches to nested format when second file is added
- Cleaner navigation UX without breaking existing multi-file sections
Auto-Generated Directory Indexes ⭐ New!
- Directories with multiple files but no index automatically generate a listing page
- No more 404 errors for valid documentation directories
- Professional listings with file titles and descriptions extracted from frontmatter
- Lists subdirectories under "Sections" and files under "Documentation Pages"
- Zero manual work required - just drop files in a folder
Smart Section Detection
- Directories with a single
.mdfile automatically serve it as the section index - No need for duplicate
index.mdfiles in simple sections - Perfect for single-page sections like "Contact" or "About"
- Priority:
home.md→README.md→index.md→ single file detection
Flexible Home Page Support
- Support for both
home.md/index.md(markdown) andhome.html/index.html(full HTML/CSS) - Priority order:
home.html→home.md→index.html→index.md - HTML pages allow full control over styling, layout, and interactive elements
- Markdown pages provide simple content editing with automatic styling
- Both formats support all placeholder tokens for dynamic content
Dynamic Placeholder System
- Content injection in both HTML and markdown home pages
{{AUTO_DOCS}}- Beautiful grid of documentation sections (HTML) or markdown list{{AUTO_DOCS_LIST}}- Simple list of documentation sections (HTML<ul>or markdown bullets){{SITE_NAME}},{{SITE_TAGLINE}},{{GITHUB_REPO_URL}}- Site information- Fork-friendly customization without code changes
- HTML pages get full HTML output, markdown pages get markdown-compatible output
Mobile Responsiveness
Second Star Docs now prevents horizontal scrolling on phones:
- Correct viewport defaults for mobile
- Long words/URLs wrap automatically
- Images/iframes are constrained to the container width
- Code blocks and tables scroll within themselves instead of widening the page
📚 Complete Documentation
Chapter 1: Getting Started
- Installation - Clone and install Second Star Docs
- File Structure - Organize your documentation
- Basic Setup - Configure your site
- First Pages - Create your initial content
- Markdown Features - Learn markdown capabilities
Chapter 2: Features
- Core Features - Everything Second Star Docs can do
- Markdown Support - Full CommonMark + GFM
- Theme System - Light/dark mode with custom colors
- Search Functionality - Client-side search with Fuse.js
Chapter 3: Deployment
- Railway.com Deployment - Complete Railway setup guide
- Custom Domains - Add your own domain
- Environment Variables - Configure your site
- Monitoring - Keep your site healthy
Chapter 4: Customization
- Custom Styling - Make it uniquely yours
- Brand Colors - Set your color palette
- Custom CSS - Complete style control
- Logo Integration - Add your branding
Chapter 5: Advanced
- Performance Optimization - Make it lightning fast
- API Reference - Advanced configuration options
- Custom Components - Extend functionality
- Analytics Integration - Track usage
Chapter 6: Support
- FAQ - Common questions answered
- Troubleshooting - Fix common issues
- Performance Issues - Optimize your site
- Getting Help - Where to find support
Additional Resources
- Changelog - Version history and updates
- License (MIT) - Open source license information
🎯 Perfect For
- Open Source Projects - Beautiful docs that attract contributors
- SaaS Applications - Professional documentation for your users
- Internal Tools - Team documentation that's actually enjoyable to use
- Developer Tools - Technical documentation that developers love
- API Documentation - Clear, searchable API references
- Product Documentation - User guides that convert
🌟 Think Neverland Developer Flight Pass
Second Star Docs is part of the Think Neverland Developer Flight Pass - premium tools and resources for developers who refuse to grow up.
Flight Pass Benefits:
- 🚀 Premium Support - Get help from our team
- 🎨 Custom Branding - Professional design services
- 🔧 Custom Development - Tailored solutions for your needs
- 📚 Exclusive Documentation - Advanced guides and tutorials
- 🎁 Early Access - New features before public release
🚀 Ready to Take Flight?
Choose your adventure:
Free Version
- Full Second Star Docs functionality
- Community support
- Railway.com deployment
- Custom branding options
Flight Pass
- Everything in Free +
- Premium support
- Custom development
- Advanced features
- Priority updates
Built with ✨ by Think Neverland
"Second star to the right, straight on 'til documentation"
Ready to start your documentation journey? Get Started Now →