Skip to content
EldanDocs

    Up/Down to navigate, Enter to open, Esc to close

    Docs

    Getting started

    Install the theme and publish your first docs page.

    Add the theme

    If you already have a Hugo site, add EldanDocs as a Git submodule, a Hugo module, or copy the theme into themes/eldandocs:

    git submodule add https://example.com/eldandocs.git themes/eldandocs
    

    Or import it as a Hugo module:

    module:
      imports:
        - path: github.com/wesleysinks/eldandocs
    

    Then set the theme in hugo.yaml (or hugo.toml):

    theme: eldandocs
    
    theme = "eldandocs"
    

    Write content

    Create content/docs/_index.md and add pages beneath it. The docs section gets a sidebar, a table of contents, and previous/next links automatically.

    hugo new --kind docs docs/example.md
    

    The archetype sets type: docs so the page uses the documentation layout even if you move it.

    Run locally

    hugo server
    

    Search works immediately in development: Hugo writes search.json into the published site on every build.