https://github.com/docura/docura

📖 A modular Hugo theme to build your next documentation site
https://github.com/docura/docura

documentation documentation-generator hugo hugo-theme

Last synced: over 1 year ago
JSON representation

📖 A modular Hugo theme to build your next documentation site

• Host: GitHub
• URL: https://github.com/docura/docura
• Owner: docura
• License: mit
• Created: 2022-09-04T15:28:18.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-24T18:38:44.000Z (almost 2 years ago)
• Last Synced: 2024-08-24T19:47:42.665Z (almost 2 years ago)
• Topics: documentation, documentation-generator, hugo, hugo-theme
• Language: SCSS
• Homepage: https://docura.github.io
• Size: 1.8 MB
• Stars: 61
• Watchers: 3
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🦄 Docura

A modular Hugo theme to build your next documentation site

## 🌱 Features

- Responsive and adaptive layouts.

- Built-in dark, light and night themes.

- Customizable menu with Hugo configs.

- Customizable sidebars using Hugo data templates.

- Support for multiple documentation sets.

- Minimal reliance on external frameworks (No CSS, JS/npm, icon, font frameworks).

- SCSS/Vanilla JS based UI components and Hugo pipes based building process.

## 🚀 Getting Started

1. [Install Hugo extended version](https://gohugo.io/installation/).

    - Use prebuilt binaries via https://github.com/gohugoio/hugo/releases/latest

    - Verify the installation via `hugo version`

2. Create a new site with the Docura theme.

    ```shell

    hugo new site newsite

    cd newsite

    git init

    git submodule add https://github.com/docura/docura.git themes/docura

    rm hugo.toml && cp themes/docura/hugo.yaml .

    hugo server

    ```