Docsify Templates

Pure Docsify template with centralized configuration - A complete, plugin-free Docsify setup where all settings are managed through a single config.json file. No external dependencies, no custom plugins, just clean and maintainable documentation.

Features

Core Docsify Features

• Automatic Sidebar Generation - No manual sidebar management
• Built-in Search - Full-text search without external plugins
• Multiple Theme Support - Switch between vue, dark, pure, and dolphin themes
• Fully Responsive - Works on mobile, tablet, and desktop
• GitHub Corner - Direct link to your repository
• Pagination - Previous/Next navigation between pages
• Cover Pages - Custom cover pages for sections

️ Centralized Configuration

• Single Configuration File - All settings in .config/config.json
• No HTML/JS Editing Required - Modify behavior through JSON only
• Environment Variables Support - Override config for different environments
• Theme Customization - Primary/secondary colors, highlight themes
• SEO Optimization - Auto-generated meta tags, descriptions, keywords

Production Ready

• Zero External Plugins - Only core Docsify dependencies
• Fast Loading - Minimal JavaScript, optimized assets
• SEO Friendly - Proper meta tags and semantic HTML
• Mobile Optimized - Touch-friendly navigation
• Easy Deployment - Works with GitHub Pages, Netlify, Vercel, and any static host
• No Build Step Required - Pure static files

Project Structure

docsify-templates/
├── .config/
│   ├── config.json        # Central configuration file
│   └── config-loader.js   # Configuration loader script
├── docs/
│   ├── README.md          # Homepage content
│   ├── getting-started.md # Example documentation
│   └── _sidebar.md        # Auto-generated sidebar
├── public/
│   └── assets/            # Custom assets (logo, favicon, images)
├── index.html             # Main entry point
├── package.json           # Project dependencies and scripts
├── .gitignore             # Git ignore rules
├── .nojekyll              # GitHub Pages bypass
├── LICENSE                # MIT License
└── README.md              # This file

Quick Start

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/docsify-templates.git
   cd docsify-templates

2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

   This will open your browser at http://localhost:3000

Configuration

All settings are managed in .config/config.json. Here's what you can customize:

{
  "site": {
    "title": "Your Project Name",
    "name": "Project Docs",
    "description": "Comprehensive documentation for your project",
    "keywords": "docs, documentation, your-project",
    "author": "Your Name",
    "favicon": "/public/assets/favicon.ico",
    "logo": "/public/assets/logo.png"
  },
  "docsify": {
    "repo": "yourusername/your-repo",
    "loadSidebar": true,
    "auto2top": true,
    "themeColor": "#42b983"
  },
  "appearance": {
    "theme": "vue",
    "darkMode": false,
    "themeColors": {
      "primary": "#42b983",
      "secondary": "#35495e"
    }
  },
  "features": {
    "search": true,
    "searchPlaceholder": "Search documentation..."
  }
}

Key Configuration Options

Section	Option	Description	Default
site	title	Browser tab title	"Docsify Templates"
site	name	Site name in header	"Docsify Templates"
site	favicon	Path to favicon	/public/assets/favicon.ico
docsify	repo	GitHub repo URL	"username/repo"
docsify	loadSidebar	Enable sidebar	true
docsify	themeColor	Primary theme color	"#42b983"
appearance	theme	Docsify theme	"vue"
appearance	darkMode	Enable dark mode	false
appearance	highlightTheme	Code highlight theme	"atom-one-dark"
features	search	Enable search functionality	true

Adding Documentation

1. Create markdown files in the docs/ directory:

   docs/
   ├── getting-started.md
   ├── configuration.md
   ├── api-reference.md
   └── examples.md

2. Update the sidebar in docs/_sidebar.md:

   - [Home](/)
   - [Getting Started](/getting-started)
   - [Configuration](/configuration)
   - [API Reference](/api-reference)
   - [Examples](/examples)

3. Add custom assets to public/assets/:

   • Logo: public/assets/logo.png
   • Favicon: public/assets/favicon.ico
   • Images: public/assets/images/

Customization

Theme Colors

Modify the theme colors in .config/config.json:

"appearance": {
  "themeColors": {
    "primary": "#2196F3",
    "secondary": "#1976D2"
  }
}

Dark Mode

Enable dark mode by setting:

"appearance": {
  "darkMode": true,
  "darkTheme": "dark"
}

Code Highlighting

Change the code highlight theme (supports all Highlight.js themes):

"appearance": {
  "highlightTheme": "github-dark"
}

Deployment

GitHub Pages

1. Create a gh-pages branch:

   git checkout -b gh-pages
   git add -f dist
   git commit -m "Deploy to GitHub Pages"
   git subtree split --prefix dist -b gh-pages
   git push -f origin gh-pages:gh-pages
   git branch -D gh-pages
   git checkout -

2. Enable GitHub Pages in repository settings:

   • Go to Settings → Pages
   • Select gh-pages branch
   • Choose /root folder

Netlify/Vercel

1. Push your code to GitHub/GitLab
2. Connect your repository to Netlify/Vercel
3. Set build command: npm run build (if you add a build step later)
4. Set publish directory: / (root directory)

Development Scripts

Command	Description
npm start	Start development server
npm run dev	Start server and open browser
npm run preview	Start server on port 4000
npm run build	Build static files (if added later)

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a pull request

Contribution Guidelines

• Follow existing code style
• Update documentation when adding new features
• Write clear commit messages
• Test your changes before submitting

FAQ

Q: Do I need to know JavaScript to use this template?

A: No! All configuration is done through the JSON file. You only need to write Markdown for your documentation.

Q: Can I add custom CSS?

A: Yes! You can add a custom CSS file in public/assets/style.css and reference it in your configuration.

Q: How do I add a cover page?

A: Create a _coverpage.md file in your docs directory and enable coverpage: true in the config.

Q: Can I use this with private repositories?

A: Absolutely! All assets are loaded locally, so there are no external dependencies that require internet access.

Q: How do I handle versioning?

A: You can create versioned documentation by organizing your files in version-specific directories (e.g., docs/v1/, docs/v2/).

License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2024 Your Name

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Acknowledgments

• Docsify - The amazing documentation generator
• Highlight.js - Beautiful syntax highlighting
• GitHub - Source code hosting and collaboration

---

⭐ Star this repository if you find it useful!
Report issues through the GitHub Issues page
Suggest features by creating a feature request

Made with ️ by Your Name | Project Homepage